Core API (2.16.3-SNAPSHOT)

Download OpenAPI specification:

ILM: info@otilm.com URL: https://www.otilm.com License: MIT License

REST API for CZERTAINLY Core

ILM Documentation

Connector Management

Connector Management API

Get details of a Connector

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"functionGroups": [{"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
],
"url": "http://network-discovery-provider:8080",
"authType": "none",
"authAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"status": "waitingForApproval",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Edit a Connector

path Parameters

uuid

required

string

Connector UUID

Request Body schema: application/json
required

url	string URL of the Connector to connect
authType	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttribute) List of authentication Attributes. Required if the authentication type is not NONE
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"url": "http://network-discovery-provicer:8080",
"authType": "none",
"authAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"functionGroups": [{"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
],
"url": "http://network-discovery-provider:8080",
"authType": "none",
"authAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"status": "waitingForApproval",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Delete a Connector

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Reconnect to a Connector

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

Content type

application/json

[{"functionGroup": {"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
}
]

Approve a Connector

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Reconnect multiple Connectors

Request Body schema: application/json
required

Connector UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Connect to a Connector

Request Body schema: application/json
required

url required	string URL of the Connector to connect
uuid	string UUID of the Connector. Mandatory if connection is needed for the same Connector
authType required	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttribute) List of authentication Attributes. Required if the authentication type is not NONE

Responses

Request samples

Payload

Content type

application/json

{"url": "http://network-discovery-provicer:8080",
"uuid": "string",
"authType": "none",
"authAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

[{"functionGroup": {"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
}
]

Approve multiple Connector

Request Body schema: application/json
required

Connector UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

List Connectors by Function Group and Kind

query Parameters

functionGroup	string (FunctionGroupCode) Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" "complianceProviderV2" "cryptographyProvider" "notificationProvider"
kind	string
status	string (ConnectorStatus) Enum: "waitingForApproval" "connected" "failed" "offline"

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"functionGroups": [{"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
],
"url": "http://network-discovery-provider:8080",
"authType": "none",
"authAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"status": "waitingForApproval",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
]

Create a new Connector

Request Body schema: application/json
required

name required	string Name of the Connector
url required	string URL of the Connector to connect
authType required	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttribute) List of authentication Attributes. Required if the authentication type is not NONE
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "Connector1",
"url": "http://network-discovery-provider:8080",
"authType": "none",
"authAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"uuid": "string"
}

Delete multiple Connectors

Request Body schema: application/json
required

Connector UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Validate Attributes

path Parameters

uuid required	string Connector UUID
functionGroup required	string Function Group name
kind required	string Kind

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Check Health of a Connector

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

Content type

application/json

{"status": "UP",
"description": "string",
"parts": {"property1": { },
"property2": { }
}
}

Get attributes of all Function Groups

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

Content type

application/json

{"property1": {"property1": [{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
],
"property2": [{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]
},
"property2": {"property1": [{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
],
"property2": [{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]
}
}

Get Attributes from a Connector

path Parameters

uuid required	string Connector UUID
functionGroup required	string (FunctionGroupCode) Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" "complianceProviderV2" "cryptographyProvider" "notificationProvider" Function Group name
kind required	string Kind

Responses

Response samples

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Force Delete multiple Connectors

Request Body schema: application/json
required

Connector UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

User Management

User Management API

Get user details

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Update User

path Parameters

userUuid

required

string

User UUID

Request Body schema: application/json
required

description	string Description of the user
firstName	string First name of the user
lastName	string Last name of the user
email required	string Email of the user
groupUuids	Array of strings Groups UUIDs of the user (set to empty list to remove certificate from all groups)
certificateData	string Base64 Content of the admin certificate
certificateUuid	string UUID of the existing certificate in the Inventory. Mandatory if certificate is not provided
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"groupUuids": ["string"
],
"certificateData": "string",
"certificateUuid": "string",
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Delete User

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Add role to User

path Parameters

userUuid required	string User UUID
roleUuid required	string Role UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Remove role from User

path Parameters

userUuid required	string User UUID
roleUuid required	string Role UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

List Users

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true
}
]

Create User

Request Body schema: application/json
required

username required	string Username of the user
description	string Description of the user
firstName	string First name of the user
lastName	string Last name of the user
email	string Email of the user
groupUuids	Array of strings Groups UUIDs of the user
enabled	boolean Status of the user. True = Enabled, False = Disabled
certificateData	string Base64 Content of the user certificate
certificateUuid	string UUID of the existing certificate in the Inventory
	Array of objects (RequestAttribute) List of Custom Attributes
name	string

Responses

Request samples

Payload

Content type

application/json

{"username": "user1",
"description": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"groupUuids": ["string"
],
"enabled": true,
"certificateData": "string",
"certificateUuid": "string",
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"name": "string"
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Identify User

Request Body schema: application/json
required

certificateContent	string Base64 Content of the certificate
authenticationToken	string Authentication Token

Responses

Request samples

Payload

Content type

application/json

{"certificateContent": "string",
"authenticationToken": "string"
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Get User Roles

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
]

Add roles to User

path Parameters

userUuid

required

string

User UUID

Request Body schema: application/json
required

Role UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Enable User

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Disable User

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Get User permissions

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"allowAllResources": true,
"resources": [{"name": "string",
"allowAllActions": true,
"actions": ["string"
],
"objects": [{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]
}
]
}

Authentication Management

Authentication Management API

Profile Authorization

Responses

Response samples

200
400
403

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"permissions": {"allowedListings": ["NONE"
]
}
}

Update User Profile

Request Body schema: application/json
required

description	string Description of the user
firstName	string First name of the user
lastName	string Last name of the user
email required	string Email of the user
groupUuids	Array of strings Groups UUIDs of the user (set to empty list to remove certificate from all groups)
certificateData	string Base64 Content of the admin certificate
certificateUuid	string UUID of the existing certificate in the Inventory. Mandatory if certificate is not provided
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"groupUuids": ["string"
],
"certificateData": "string",
"certificateUuid": "string",
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Get Auth Resources

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "NONE",
"displayName": "string",
"listObjectsEndpoint": "string",
"objectAccess": true,
"actions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"displayName": "string"
}
]
}
]

Get List of objects for Object Access

path Parameters

resourceName

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Resource Name

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]

Scheduled Jobs Management

Scheduled Jobs Management API

Scheduled job detail

path Parameters

uuid

required

string

Scheduled job UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"jobName": "string",
"jobType": "string",
"cronExpression": "string",
"enabled": true,
"oneTime": true,
"system": true,
"lastExecutionStatus": "started",
"userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
"objectData": null
}

Edit Scheduled job

path Parameters

uuid

required

string

Scheduled job UUID

Request Body schema: application/json
required

cronExpression

string

Cron expression for job schedule

Responses

Request samples

Payload

Content type

application/json

{"cronExpression": "string"
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"jobName": "string",
"jobType": "string",
"cronExpression": "string",
"enabled": true,
"oneTime": true,
"system": true,
"lastExecutionStatus": "started",
"userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
"objectData": null
}

Delete Scheduled job

path Parameters

uuid

required

string

Scheduled job UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enabling of Scheduled job

path Parameters

uuid

required

string

Scheduled job UUID

Responses

Disabling of Scheduled job

path Parameters

uuid

required

string

Scheduled job UUID

Responses

List of scheduled jobs

query Parameters

itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Response samples

200
400
403

Content type

application/json

{"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0,
"scheduledJobs": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"jobName": "string",
"jobType": "string",
"cronExpression": "string",
"enabled": true,
"oneTime": true,
"system": true,
"lastExecutionStatus": "started"
}
]
}

Scheduled job history

path Parameters

uuid

required

string

Scheduled job UUID

query Parameters

itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Response samples

200
400
403
404

Content type

application/json

{"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0,
"scheduledJobHistory": [{"jobUuid": "f6cd1d43-0519-40a4-895b-ab314e905ac3",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"status": "started",
"resultMessage": "string",
"resultObjectType": "NONE",
"resultObjectIdentification": ["string"
]
}
]
}

Client Operations v2

Client Operations v2 API

Issue Certificate

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Request Body schema: application/json
required

	Array of objects (RequestAttribute) List of attributes to create CSR. Required if CSR is not provided
	Array of objects (RequestAttribute) List of attributes to sign the CSR
	Array of objects (RequestAttribute) List of attributes to sign the alternative private key
request required	string Certificate signing request encoded as Base64 string
format	string (CertificateRequestFormat) Default: "pkcs10" Enum: "pkcs10" "crmf" Certificate signing request format
tokenProfileUuid	string <uuid> Token Profile UUID. Required if CSR is not uploaded
keyUuid	string <uuid> Key UUID. Required if CSR is not uploaded
altTokenProfileUuid	string <uuid> Token Profile UUID for the alternative key.
altKeyUuid	string <uuid> Alternative Key UUID.
required	Array of objects (RequestAttribute) List of RA Profile related Attributes to issue Certificate
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"csrAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"signatureAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"altSignatureAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"request": "string",
"format": "pkcs10",
"tokenProfileUuid": "66f2e24c-4f07-496b-b5c4-6fe8a5e8361a",
"keyUuid": "a0e39a6c-fae3-43d6-99c3-a3620775a368",
"altTokenProfileUuid": "487a31a3-090d-4b19-9b24-0ff6d52ff0e9",
"altKeyUuid": "ae57c41d-5798-439d-bc96-b05c70b20ac1",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"certificateData": "string",
"uuid": "string"
}

Revoke Certificate

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID
certificateUuid required	string Certificate UUID

Request Body schema: application/json
required

reason	string (CertificateRevocationReason) Default: "UNSPECIFIED" Enum: "unspecified" "keyCompromise" "cACompromise" "affiliationChanged" "superseded" "cessationOfOperation" "certificateHold" "privilegeWithdrawn" "aACompromise" Reason for revocation
required	Array of objects (RequestAttribute) List of Attributes to revoke Certificate
destroyKey	boolean Default: false Destroy Key upon successful revocation

Responses

Request samples

Payload

Content type

application/json

{"reason": "unspecified",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"destroyKey": false
}

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Renew Certificate

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID
certificateUuid required	string Certificate UUID

Request Body schema: application/json
required

replaceInLocations	boolean Default: false True to replace renewed certificate in the associated locations
request	string Certificate signing request encoded as Base64 string. If not provided, Existing CSR will be used
format	string (CertificateRequestFormat) Default: "pkcs10" Enum: "pkcs10" "crmf" Certificate signing request format

Responses

Request samples

Payload

Content type

application/json

{"replaceInLocations": false,
"request": "string",
"format": "pkcs10"
}

Response samples

Content type

application/json

{"certificateData": "string",
"uuid": "string"
}

Rekey Certificate

The rekey operation is used to request a new certificate with a new key pair. The new certificate will be issued with the same subject and attributes as the original certificate, but with a new public key. Therefore, new certificate signing request (CSR) with new key pair needs to be provided, or new key pair managed by the platform needs to be selected. When the same key pair is used, or the subject is changed, the rekey operation will be rejected.

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID
certificateUuid required	string Certificate UUID

Request Body schema: application/json
required

replaceInLocations	boolean Default: false True to replace renewed certificate in the associated locations
request	string Certificate signing request encoded as Base64 string. If not provided, CSR attributes will be used
format	string (CertificateRequestFormat) Default: "pkcs10" Enum: "pkcs10" "crmf" Certificate signing request format
keyUuid	string <uuid> Key UUID
tokenProfileUuid	string <uuid> Token Profile UUID
altKeyUuid	string <uuid> Alternative Key UUID
altTokenProfileUuid	string <uuid> Token Profile UUID for the alternative key
	Array of objects (RequestAttribute) Signature Attributes. If not provided, existing attributes will be used to generate the new CSR
	Array of objects (RequestAttribute) Alternative Signature Attributes. If not provided, existing alternative attributes will be used to generate the new CSR

Responses

Request samples

Payload

Content type

application/json

{"replaceInLocations": false,
"request": "string",
"format": "pkcs10",
"keyUuid": "a0e39a6c-fae3-43d6-99c3-a3620775a368",
"tokenProfileUuid": "66f2e24c-4f07-496b-b5c4-6fe8a5e8361a",
"altKeyUuid": "ae57c41d-5798-439d-bc96-b05c70b20ac1",
"altTokenProfileUuid": "487a31a3-090d-4b19-9b24-0ff6d52ff0e9",
"signatureAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"altSignatureAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"certificateData": "string",
"uuid": "string"
}

Issue existing certificate with status Requested

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID
certificateUuid required	string Certificate UUID

Responses

Response samples

Content type

application/json

{"certificateData": "string",
"uuid": "string"
}

Validate revocation Attributes

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Validate issue Certificate Attributes

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

Content type

application/json

{"message": "Error message"
}

Get revocation Attributes

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Get issue Certificate Attributes

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Global Metadata

Global Metadata API

Global Metadata details

path Parameters

uuid

required

string

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"name": "string",
"contentType": "string",
"description": "string",
"enabled": true,
"protectionLevel": "none",
"type": "data",
"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes"
}

Edit Global Metadata

path Parameters

uuid

required

string

Global Metadata UUID

Request Body schema: application/json
required

description	string Attribute description
label required	string Friendly name of the the Attribute
visible	boolean Default: true Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user.
group	string Group of the Attribute, used for the logical grouping of the Attribute

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes"
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"name": "string",
"contentType": "string",
"description": "string",
"enabled": true,
"protectionLevel": "none",
"type": "data",
"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes"
}

Delete Global Metadata

path Parameters

uuid

required

string

Global Metadata UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List Global Metadata

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "string",
"name": "string",
"contentType": "string",
"description": "string",
"enabled": true,
"protectionLevel": "none"
}
]

Create Global Metadata

Request Body schema: application/json
required

name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Attribute Content Type
description	string Attribute description
label required	string Friendly name of the the Attribute
visible	boolean Default: true Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user.
group	string Group of the Attribute, used for the logical grouping of the Attribute

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"contentType": "string",
"description": "string",
"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes"
}

Response samples

201
400
403

Content type

application/json

{"uuid": "string"
}

Delete multiple Global Metadata

Request Body schema: application/json
required

Global Metadata UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Get Available Connector Metadata

query Parameters

connectorUuid

string

Responses

Response samples

204
400
403

Content type

application/json

[{"name": "string",
"uuid": "string",
"contentType": "string",
"label": "string",
"connectorUuid": "string"
}
]

Promote Connector Metadata to Global Metadata

Request Body schema: application/json
required

uuid required	string Metadata UUID
connectorUuid required	string Connector UUID

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"connectorUuid": "string"
}

Response samples

204
400
403
404

Content type

application/json

{"uuid": "string",
"name": "string",
"contentType": "string",
"description": "string",
"enabled": true,
"protectionLevel": "none",
"type": "data",
"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes"
}

Statistics/Dashboard

Statistics/Dashboard API

Get Dashboard/Statistics Details

query Parameters

includeArchived

boolean

Default: false

Include archived certificates in the statistics

Responses

Response samples

200
400
403

Content type

application/json

{"totalCertificates": 0,
"totalGroups": 0,
"totalDiscoveries": 0,
"totalConnectors": 0,
"totalRaProfiles": 0,
"totalCredentials": 0,
"totalAuthorities": 0,
"totalAdministrators": 0,
"totalClients": 0,
"groupStatByCertificateCount": {"property1": 0,
"property2": 0
},
"raProfileStatByCertificateCount": {"property1": 0,
"property2": 0
},
"certificateStatByType": {"property1": 0,
"property2": 0
},
"certificateStatByExpiry": {"property1": 0,
"property2": 0
},
"certificateStatByKeySize": {"property1": 0,
"property2": 0
},
"certificateStatBySubjectType": {"property1": 0,
"property2": 0
},
"certificateStatByState": {"property1": 0,
"property2": 0
},
"certificateStatByValidationStatus": {"property1": 0,
"property2": 0
},
"certificateStatByComplianceStatus": {"property1": 0,
"property2": 0
},
"connectorStatByStatus": {"property1": 0,
"property2": 0
},
"raProfileStatByStatus": {"property1": 0,
"property2": 0
},
"administratorStatByStatus": {"property1": 0,
"property2": 0
},
"clientStatByStatus": {"property1": 0,
"property2": 0
}
}

Local operations

API only accessible from localhost

Create Administrator

Request Body schema: application/json
required

username required	string Username of the user
description	string Description of the user
firstName	string First name of the user
lastName	string Last name of the user
email	string Email of the user
groupUuids	Array of strings Groups UUIDs of the user
enabled	boolean Status of the user. True = Enabled, False = Disabled
certificateData	string Base64 Content of the user certificate
certificateUuid	string UUID of the existing certificate in the Inventory
	Array of objects (RequestAttribute) List of Custom Attributes
name	string

Responses

Request samples

Payload

Content type

application/json

{"username": "user1",
"description": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"groupUuids": ["string"
],
"enabled": true,
"certificateData": "string",
"certificateUuid": "string",
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"name": "string"
}

Response samples

200
400
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Credential Management

Credential Management API

Details of a Credentials

path Parameters

uuid

required

string

Credential UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"kind": "SoftKeyStore, Basic, ApiKey, etc",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"connectorUuid": "string",
"connectorName": "string"
}

Edit Credential

path Parameters

uuid

required

string

Credential UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) List of Credential Attributes
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"kind": "SoftKeyStore, Basic, ApiKey, etc",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"connectorUuid": "string",
"connectorName": "string"
}

Delete Credential

path Parameters

uuid

required

string

Credential UUID

Responses

Response samples

Content type

application/json

{"message": "Error message"
}

List of All Credentials

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"kind": "SoftKeyStore, Basic, ApiKey, etc",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"connectorUuid": "string",
"connectorName": "string"
}
]

Add Credential

Request Body schema: application/json
required

name required	string Credential name
kind required	string Credential Kind
required	Array of objects (RequestAttribute) List of Credential Attributes
	Array of objects (RequestAttribute) List of Custom Attributes
connectorUuid required	string UUID of Credential provider Connector

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"kind": "SoftKeyStore, Basic, ApiKey, etc",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"connectorUuid": "string"
}

Response samples

Content type

application/json

{"uuid": "string"
}

Delete multiple Credentials

Request Body schema: application/json
required

Credential UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type

application/json

{"message": "Error message"
}

Enable Credential

path Parameters

uuid

required

string

Credential UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Disable Credential

path Parameters

uuid

required

string

Credential UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Workflow Triggers Management

Workflow Triggers Management API

Get Trigger details

path Parameters

triggerUuid

required

string

Trigger UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "event",
"resource": "NONE",
"ignoreTrigger": true,
"event": "certificate_status_changed",
"rules": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"conditions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]
}
],
"actions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"executions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
]
}
]
}

Update Trigger

path Parameters

triggerUuid

required

string

Trigger UUID

Request Body schema: application/json
required

description	string Description of the trigger
type	string (TriggerType) Enum: "event" "manual" Type of the trigger
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the trigger
ignoreTrigger required	boolean Flag if to ignore object when trigger rules are matched and do not perform any actions and stop evaluating other triggers. Based on context could have other implications to object processing. If ignore is set, trigger does not have any actions.
event	string (ResourceEvent) Enum: "certificate_status_changed" "certificate_action_performed" "certificate_discovered" "certificate_expiring" "certificate_not_compliant" "discovery_finished" "approval_requested" "approval_closed" "scheduled_job_finished" Event that trigger can be assigned to
rulesUuids	Array of strings List of UUIDs of existing rules to add to the trigger
actionsUuids	Array of strings List of UUIDs of existing actions to add to the trigger

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"type": "event",
"resource": "NONE",
"ignoreTrigger": true,
"event": "certificate_status_changed",
"rulesUuids": ["string"
],
"actionsUuids": ["string"
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "event",
"resource": "NONE",
"ignoreTrigger": true,
"event": "certificate_status_changed",
"rules": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"conditions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]
}
],
"actions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"executions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
]
}
]
}

Delete Trigger

path Parameters

triggerUuid

required

string

Trigger UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List Triggers

query Parameters

resource

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "event",
"resource": "NONE",
"ignoreTrigger": true,
"event": "certificate_status_changed"
}
]

Create Trigger

Request Body schema: application/json
required

name required	string Name of the trigger
description	string Description of the trigger
type	string (TriggerType) Enum: "event" "manual" Type of the trigger
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the trigger
ignoreTrigger required	boolean Flag if to ignore object when trigger rules are matched and do not perform any actions and stop evaluating other triggers. Based on context could have other implications to object processing. If ignore is set, trigger does not have any actions.
event	string (ResourceEvent) Enum: "certificate_status_changed" "certificate_action_performed" "certificate_discovered" "certificate_expiring" "certificate_not_compliant" "discovery_finished" "approval_requested" "approval_closed" "scheduled_job_finished" Event that trigger can be assigned to
rulesUuids	Array of strings List of UUIDs of existing rules to add to the trigger
actionsUuids	Array of strings List of UUIDs of existing actions to add to the trigger

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"type": "event",
"resource": "NONE",
"ignoreTrigger": true,
"event": "certificate_status_changed",
"rulesUuids": ["string"
],
"actionsUuids": ["string"
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "event",
"resource": "NONE",
"ignoreTrigger": true,
"event": "certificate_status_changed",
"rules": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"conditions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]
}
],
"actions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"executions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
]
}
]
}

Associate event with triggers

Request Body schema: application/json
required

event required	string (ResourceEvent) Enum: "certificate_status_changed" "certificate_action_performed" "certificate_discovered" "certificate_expiring" "certificate_not_compliant" "discovery_finished" "approval_requested" "approval_closed" "scheduled_job_finished" Resource event
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Event triggers association resource
objectUuid required	string <uuid> Event triggers association object UUID
triggerUuids required	Array of strings <uuid> [ items <uuid > ] List of triggers associated with event

Responses

Request samples

Payload

Content type

application/json

{"event": "certificate_status_changed",
"resource": "NONE",
"objectUuid": "099486af-28ad-4686-8639-67f5d62fa89c",
"triggerUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Trigger History

path Parameters

triggerUuid required	string Trigger UUID
associationObjectUuid required	string Trigger Association Object UUID

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "string",
"triggerUuid": "string",
"objectUuid": "string",
"referenceObjectUuid": "string",
"conditionsMatched": true,
"actionsPerformed": true,
"triggeredAt": "2019-08-24T14:15:22Z",
"message": "string",
"records": [{"message": "string",
"condition": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
},
"execution": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
}
]
}
]

Get Trigger History Summary

path Parameters

associationObjectUuid

required

string

Trigger Association Object UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"associationResource": "NONE",
"associationObjectUuid": "string",
"objectsResource": "NONE",
"objectsEvaluated": 0,
"objectsMatched": 0,
"objectsIgnored": 0,
"objects": [{"objectUuid": "099486af-28ad-4686-8639-67f5d62fa89c",
"referenceObjectUuid": "7a517f58-be85-4019-b82a-683e436bf748",
"matched": true,
"ignored": true,
"triggers": [{"triggerUuid": "ca4fb7a3-f773-4484-9f51-9819f1ae7343",
"triggerName": "string",
"triggeredAt": "2019-08-24T14:15:22Z",
"message": "string",
"records": [{"message": "string",
"condition": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": null,
"fieldIdentifier": null,
"operator": null,
"value": null
}
]
},
"execution": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": null,
"fieldIdentifier": null,
"notificationProfileUuid": null,
"notificationProfileName": null,
"data": null
}
]
}
}
]
}
]
}
]
}

Get event triggers associations for resource object

path Parameters

resource

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Resource

associationObjectUuid

required

string <uuid>

Association object UUID

Responses

Response samples

200
400
403

Content type

application/json

{"property1": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"property2": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Callback

Callback API

Resource Callback API

API to trigger the Callback for resource.

path Parameters

resource

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Name of the resource

parentObjectUuid

required

string

Parent Object UUID

Request Body schema: application/json
required

uuid	string UUID of the Attribute
name required	string Name of the Attribute
	object Map of path variables supported by the callback method
	object Map of the query parameters supported by the callback method
	object Request body for the callback method
	object Filter for the resource callback method
	object (PaginationRequestDto) Pagination of the callback response

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"name": "string",
"pathVariable": {"property1": null,
"property2": null
},
"requestParameter": {"property1": null,
"property2": null
},
"body": {"property1": null,
"property2": null
},
"filter": {"property1": null,
"property2": null
},
"pagination": {"itemsPerPage": 10,
"pageNumber": 1
}
}

Response samples

Content type

application/json

{ }

Connector Callback API

API to trigger the Callback for Connector.

path Parameters

uuid required	string Connector UUID
functionGroup required	string Function Group
kind required	string Kind

Request Body schema: application/json
required

uuid	string UUID of the Attribute
name required	string Name of the Attribute
	object Map of path variables supported by the callback method
	object Map of the query parameters supported by the callback method
	object Request body for the callback method
	object Filter for the resource callback method
	object (PaginationRequestDto) Pagination of the callback response

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"name": "string",
"pathVariable": {"property1": null,
"property2": null
},
"requestParameter": {"property1": null,
"property2": null
},
"body": {"property1": null,
"property2": null
},
"filter": {"property1": null,
"property2": null
},
"pagination": {"itemsPerPage": 10,
"pageNumber": 1
}
}

Response samples

Content type

application/json

{ }

External Notification Management

External Notification Management API for managing notification instances that can be used to notify recipient(s) about events that were triggered in the platform. Note that this API does not handle internal notifications. For internal notifications, please refer to the Internal Notification API

Details of an Notification instance

path Parameters

uuid

required

string

Notification instance UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"attributeMappings": [{"mappingAttributeUuid": "string",
"mappingAttributeName": "string",
"customAttributeUuid": "string",
"customAttributeLabel": "string"
}
]
}

Edit Notification instance

path Parameters

uuid

required

string

Notification instance UUID

Request Body schema: application/json
required

description	string Notification instance description
required	Array of objects (RequestAttribute) List of Notification instance Attributes
	Array of objects (AttributeMappingDto) List of attribute mappings between mapping attributes and (recipient) custom attributes

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"attributeMappings": [{"mappingAttributeUuid": "string",
"mappingAttributeName": "string",
"customAttributeUuid": "string",
"customAttributeLabel": "string"
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"attributeMappings": [{"mappingAttributeUuid": "string",
"mappingAttributeName": "string",
"customAttributeUuid": "string",
"customAttributeLabel": "string"
}
]
}

Delete Notification instance

path Parameters

uuid

required

string

Notification instance UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

List of available Notification instances

Responses

Response samples

200
400
403
502
503

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"attributeMappings": [{"mappingAttributeUuid": "string",
"mappingAttributeName": "string",
"customAttributeUuid": "string",
"customAttributeLabel": "string"
}
]
}
]

Add Notification instance

Request Body schema: application/json
required

description	string Notification instance description
required	Array of objects (RequestAttribute) List of Notification instance Attributes
	Array of objects (AttributeMappingDto) List of attribute mappings between mapping attributes and (recipient) custom attributes
name required	string Notification instance name
connectorUuid required	string UUID of Notification provider
kind required	string Notification instance Kind

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"attributeMappings": [{"mappingAttributeUuid": "string",
"mappingAttributeName": "string",
"customAttributeUuid": "string",
"customAttributeLabel": "string"
}
],
"name": "string",
"connectorUuid": "string",
"kind": "string"
}

Response samples

Content type

application/json

{"uuid": "string"
}

List of mapping attributes

path Parameters

connectorUuid required	string Connector UUID
kind required	string Kind

Responses

Response samples

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Location Management

Location Management API

Get Location Details

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"pushAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"csrAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
]
}

Edit Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Request Body schema: application/json
required

description	string Description of the Location
required	Array of objects (RequestAttribute) List of Attributes for Location
	Array of objects (RequestAttribute) List of Custom Attributes
enabled	boolean Enabled flag - true = enabled; false = disabled

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"enabled": true
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"pushAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"csrAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
]
}

Delete Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Responses

Sync Location content

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"pushAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"csrAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
]
}

Push Certificate to Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID
certificateUuid required	string Certificate UUID

Request Body schema: application/json
required

required

Array of objects (RequestAttribute)

List of push Attributes for Location

Responses

Request samples

Payload

Content type

application/json

{"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"pushAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"csrAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
]
}

Remove Certificate from Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID
certificateUuid required	string Certificate UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"pushAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"csrAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
]
}

Renew Certificate in Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID
certificateUuid required	string Certificate UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"pushAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"csrAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
]
}

List Locations

Request Body schema: application/json
required

	Array of objects (SearchFilterRequestDto) Certificate filter input
itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": null
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

200
400
403
502
503

Content type

application/json

{"locations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [null
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [null
],
"version": "v2"
}
]
}
],
"pushAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"csrAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
]
}
],
"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0
}

Add Location

path Parameters

entityUuid

required

string

Entity UUID

Request Body schema: application/json
required

name required	string Location name
description	string Location description
required	Array of objects (RequestAttribute) List of Attributes to register Location
	Array of objects (RequestAttribute) List of Custom Attributes
enabled	boolean Default: false Enabled flag - true = enabled; false = disabled

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"enabled": false
}

Response samples

Content type

application/json

{"uuid": "string"
}

Issue Certificate to Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Request Body schema: application/json
required

raProfileUuid required	string RA Profile UUID
required	Array of objects (RequestAttribute) List of CSR Attributes for Location
required	Array of objects (RequestAttribute) List of certificate issue Attributes for RA Profile
	Array of objects (RequestAttribute) List of Custom Attributes
	Array of objects (RequestAttribute) List of Certificate Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"raProfileUuid": "string",
"csrAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"issueAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"certificateCustomAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"pushAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"csrAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
]
}

Enable Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Responses

Disable Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Responses

Get Locations searchable fields information

Responses

Response samples

200
400
403
502
503

Content type

application/json

[{"filterFieldSource": "meta",
"searchFieldData": [{"fieldIdentifier": "string",
"fieldLabel": "string",
"type": "string",
"conditions": ["EQUALS"
],
"platformEnum": "Resource",
"attributeContentType": "string",
"value": null,
"multiValue": true
}
]
}
]

Get push Attributes

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Responses

Response samples

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Get CSR Attributes

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Responses

Response samples

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Entity Management

Entity Management API

Get Entity instance details

path Parameters

entityUuid

required

string

Entity instance UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "Keystore, etc."
}

Edit Entity instance

path Parameters

entityUuid

required

string

Entity instance UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) List of Entity instance Attributes
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "Keystore, etc."
}

Delete Entity instance

path Parameters

entityUuid

required

string

Entity instance UUID

Responses

Add Entity instance

Request Body schema: application/json
required

name required	string Entity instance name
required	Array of objects (RequestAttribute) List of Entity instance Attributes
	Array of objects (RequestAttribute) List of Custom Attributes
connectorUuid required	string UUID of Entity Provider
kind required	string Entity instance Kind

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"connectorUuid": "string",
"kind": "Keystore, etc."
}

Response samples

Content type

application/json

{"uuid": "string"
}

Validate Location Attributes

path Parameters

entityUuid

required

string

Entity instance UUID

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

422

Content type

*/*

[
  "Error Message 1",
  "Error Message 2"
]

List Entity instances

Request Body schema: application/json
required

	Array of objects (SearchFilterRequestDto) Certificate filter input
itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": null
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

200
400
403
502
503

Content type

application/json

{"entities": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "Keystore, etc."
}
],
"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0
}

List Location Attributes

path Parameters

entityUuid

required

string

Entity instance UUID

Responses

Response samples

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Get Entities searchable fields information

Responses

Response samples

200
400
403
502
503

Content type

application/json

[{"filterFieldSource": "meta",
"searchFieldData": [{"fieldIdentifier": "string",
"fieldLabel": "string",
"type": "string",
"conditions": ["EQUALS"
],
"platformEnum": "Resource",
"attributeContentType": "string",
"value": null,
"multiValue": true
}
]
}
]

Authority Management

Authority Management API

Details of an Authority instance

path Parameters

uuid

required

string

Authority instance UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "LegacyEjbca, ADCS, etc."
}

Edit Authority instance

path Parameters

uuid

required

string

Authority instance UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) List of Authority instance Attributes
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "LegacyEjbca, ADCS, etc."
}

Delete Authority instance

path Parameters

uuid

required

string

Authority instance UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

List of available Authority instances

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "LegacyEjbca, ADCS, etc."
}
]

Add Authority instance

Request Body schema: application/json
required

name required	string Authority instance name
required	Array of objects (RequestAttribute) List of Authority instance Attributes
	Array of objects (RequestAttribute) List of Custom Attributes
connectorUuid required	string UUID of Authority provider
kind required	string Authority instance Kind

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"connectorUuid": "string",
"kind": "LegacyEjbca, ADCS, etc"
}

Response samples

Content type

application/json

{"uuid": "string"
}

Delete multiple Authority instances

Request Body schema: application/json
required

Authority Instance UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Validate RA Profile Attributes

path Parameters

uuid

required

string

Authority instance UUID

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

List entity profiles

path Parameters

uuid

required

string

Authority instance UUID

Responses

Response samples

Content type

application/json

[{"id": 0,
"name": "string"
}
]

List certificate profiles

path Parameters

uuid required	string Authority instance UUID
endEntityProfileId required	integer <int32>

Responses

Response samples

Content type

application/json

[{"id": 0,
"name": "string"
}
]

List CAs in Profile

path Parameters

uuid required	string Authority instance UUID
endEntityProfileId required	integer <int32>

Responses

Response samples

Content type

application/json

[{"id": 0,
"name": "string"
}
]

List RA Profile Attributes

path Parameters

uuid

required

string

Authority instance UUID

Responses

Response samples

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Force delete multiple Authority instances

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

RA Profile Management

RA Profile Management API

Details of RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"authorityInstanceUuid": "string",
"authorityInstanceName": "string",
"legacyAuthority": true,
"enabled": true,
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabledProtocols": ["string"
],
"certificateValidationSettings": {"enabled": true,
"frequency": 1,
"expiringThreshold": 1
}
}

Edit RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Request Body schema: application/json
required

description	string Description of RA Profile
required	Array of objects (RequestAttribute) List of Attributes for RA Profile
	Array of objects (RequestAttribute) List of Custom Attributes
enabled	boolean Enabled flag - true = enabled; false = disabled

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"enabled": true
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"authorityInstanceUuid": "string",
"authorityInstanceName": "string",
"legacyAuthority": true,
"enabled": true,
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabledProtocols": ["string"
],
"certificateValidationSettings": {"enabled": true,
"frequency": 1,
"expiringThreshold": 1
}
}

Delete RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Initiate Certificate Compliance Check Deprecated

Request Body schema: application/json
required

RA Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Create RA Profile

path Parameters

authorityUuid

required

string

Authority Instance UUID

Request Body schema: application/json
required

name required	string RA Profile name
description	string RA Profile description
required	Array of objects (RequestAttribute) List of Attributes to create RA Profile
	Array of objects (RequestAttribute) List of Custom Attributes
enabled	boolean Default: false Enabled flag - true = enabled; false = disabled

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"enabled": false
}

Response samples

Content type

application/json

{"uuid": "string"
}

Enable multiple RA Profiles

Request Body schema: application/json
required

RA Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Disable multiple RA Profiles

Request Body schema: application/json
required

RA Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Update validation configuration of RA profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Request Body schema: application/json
required

enabled	boolean Indicator whether validation of certificates associated with RA profile should be enabled, if null, then values in platform settings will be used
frequency	integer <int32> >= 1 Default: 1 Frequency of validation of certificates in days, when not set, value in platform settings is used
expiringThreshold	integer <int32> >= 1 Default: 30 How many days before expiration should certificate validation status change to Expiring, when not set, value in platform settings is used

Responses

Request samples

Payload

Content type

application/json

{"enabled": true,
"frequency": 1,
"expiringThreshold": 30
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"authorityInstanceUuid": "string",
"authorityInstanceName": "string",
"legacyAuthority": true,
"enabled": true,
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabledProtocols": ["string"
],
"certificateValidationSettings": {"enabled": true,
"frequency": 1,
"expiringThreshold": 1
}
}

Deactivate SCEP for RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

{"message": "Error message"
}

Activate SCEP for RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID
scepProfileUuid required	string SCEP Profile UUID

Request Body schema: application/json
required

required

Array of objects (RequestAttribute)

List of Attributes to issue Certificate

Responses

Request samples

Payload

Content type

application/json

{"issueCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"scepAvailable": true,
"url": "string",
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Deactivate CMP for RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

{"message": "Error message"
}

Activate CMP for RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID
cmpProfileUuid required	string CMP Profile UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) List of Attributes to issue Certificate
required	Array of objects (RequestAttribute) List of Attributes to revoke Certificate

Responses

Request samples

Payload

Content type

application/json

{"issueCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"revokeCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"cmpAvailable": true,
"cmpUrl": "string",
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"revokeCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Deactivate ACME for RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

{"message": "Error message"
}

Activate ACME for RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID
acmeProfileUuid required	string ACME Profile UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) List of Attributes to issue Certificate
required	Array of objects (RequestAttribute) List of Attributes to revoke Certificate

Responses

Request samples

Payload

Content type

application/json

{"issueCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"revokeCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"acmeAvailable": true,
"directoryUrl": "string",
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"revokeCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Enable RA Profiles

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Disable RA Profiles

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Disassociated RA profile with the Approval profile

path Parameters

authorityUuid required	string Authority instance UUID
raProfileUuid required	string RA profile UUID
approvalProfileUuid required	string Approval profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Associated RA profile with the Approval profile

path Parameters

authorityUuid required	string Authority instance UUID
raProfileUuid required	string RA profile UUID
approvalProfileUuid required	string Approval profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

List of available RA Profiles

query Parameters

enabled

boolean

Responses

Response samples

200
400
403
502
503

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"authorityInstanceUuid": "string",
"authorityInstanceName": "string",
"legacyAuthority": true,
"enabled": true,
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabledProtocols": ["string"
],
"certificateValidationSettings": {"enabled": true,
"frequency": 1,
"expiringThreshold": 1
}
}
]

Delete multiple RA Profiles

Request Body schema: application/json
required

RA Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type

application/json

{"message": "Error message"
}

Details of RA Profile without Authority

path Parameters

raProfileUuid

required

string

RA Profile UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"authorityInstanceUuid": "string",
"authorityInstanceName": "string",
"legacyAuthority": true,
"enabled": true,
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabledProtocols": ["string"
],
"certificateValidationSettings": {"enabled": true,
"frequency": 1,
"expiringThreshold": 1
}
}

Delete RA Profile without Authority

path Parameters

raProfileUuid

required

string

RA Profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Get SCEP details for RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"scepAvailable": true,
"url": "string",
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Get CMP details for RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"cmpAvailable": true,
"cmpUrl": "string",
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"revokeCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Get ACME details for RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"acmeAvailable": true,
"directoryUrl": "string",
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"revokeCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Get Compliance Profiles for an RA Profile Deprecated

path Parameters

authorityUuid required	string Authority UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string"
}
]

Retrieve certificates of authority belonging to RA profile

path Parameters

authorityUuid required	string Authority instance UUID
raProfileUuid required	string RA profile UUID

Responses

Response samples

Content type

application/json

[{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false,
"extendedKeyUsage": ["string"
],
"keyUsage": ["digitalSignature"
],
"subjectType": "endEntity",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"certificateContent": "string",
"subjectAlternativeNames": {"property1": ["string"
],
"property2": ["string"
]
},
"locations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [ ],
"uuid": null,
"name": null,
"label": null,
"type": null,
"contentType": null,
"content": [ ],
"version": null
}
]
}
],
"pushAttributes": [{"content": [{"reference": null,
"data": null
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"csrAttributes": [{"content": [{"reference": null,
"data": null
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": null,
"name": null
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": null,
"data": null,
"contentType": null
}
],
"version": "v2"
}
]
}
]
}
],
"nonCompliantRules": [{"connectorName": "Provider1",
"ruleName": "RuleName",
"ruleDescription": "Description sample",
"status": "ok",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"key": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"keyWrapperUuid": "string",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [null
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"associations": 0,
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"length": 0,
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"complianceStatus": "not_checked"
}
],
"associations": 0,
"complianceStatus": "not_checked"
},
"altKey": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"keyWrapperUuid": "string",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [null
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"associations": 0,
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"length": 0,
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"complianceStatus": "not_checked"
}
],
"associations": 0,
"complianceStatus": "not_checked"
},
"certificateRequest": {"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"certificateType": "X.509",
"certificateRequestFormat": "pkcs10",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"content": "string",
"commonName": "string",
"subjectDn": "string",
"subjectAlternativeNames": {"property1": ["string"
],
"property2": ["string"
]
},
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"signatureAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"altSignatureAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"keyUuid": "string",
"altKeyUuid": "string",
"complianceStatus": "not_checked"
},
"sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
"issueAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"revokeAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"relatedCertificates": [{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": null,
"data": null
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
}
],
"protocolInfo": {"protocol": "acme",
"protocolProfileUuid": "a286b9c7-97ed-44c6-a837-e8415ab11bf4",
"additionalProtocolUuid": "bcf08956-ad5e-4c4a-863d-293464f7e308"
}
}
]

Get revocation Attributes

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Get issue Certificate Attributes

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

List of Approval profiles associated with the RAProfile

path Parameters

authorityUuid required	string Authority instance UUID
raProfileUuid required	string RA profile UUID

Responses

Response samples

Content type

application/json

[{"uuid": "string",
"name": "ApprovalProfile1",
"version": 1,
"description": "Detail description of the approval profile",
"expiry": 24,
"numberOfSteps": 2,
"associations": 0
}
]

CMP Profile Management

CMP Profile Management API

Get details of CMP Profile

path Parameters

cmpProfileUuid

required

string

CMP Profile UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"variant": "v2",
"description": "Sample text description",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"cmpUrl": "https://your-domain.com/api/v1/protocols/cmp/cmpProfile",
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"revokeCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"requestProtectionMethod": "sharedSecret",
"responseProtectionMethod": "sharedSecret",
"signingCertificate": {"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
},
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
}

Edit CMP Profile

path Parameters

cmpProfileUuid

required

string

CMP Profile UUID

Request Body schema: application/json
required

description	string Description of the CMP Profile
raProfileUuid	string RA Profile UUID that the CMP Profile is associated with
	Array of objects (RequestAttribute) List of Attributes to issue Certificate for the associated RA Profile. Required when raProfileUuid is provided
	Array of objects (RequestAttribute) List of Attributes to revoke Certificate for the associated RA Profile. Required when raProfileUuid is provided
	Array of objects (RequestAttribute) List of Custom Attributes for CMP Profile
requestProtectionMethod required	string (ProtectionMethod) Enum: "sharedSecret" "signature" Protection Method for the CMP Request
responseProtectionMethod required	string (ProtectionMethod) Enum: "sharedSecret" "signature" Protection Method for the CMP Response
sharedSecret	string Shared secret for the CMP Request. Required when requestProtectionMethod is sharedSecret
signingCertificateUuid	string UUID of the Certificate to be used as signing certificate for CMP responses. Required when responseProtectionMethod is signature
	object (ProtocolCertificateAssociationsRequestDto) Associations to set for certificates issued by the protocol
name required	string non-empty Name of the CMP Profile
variant required	string Enum: "v2" "v2_3gpp" "v3" Variant of the CMP Profile

Responses

Request samples

Payload

Content type

application/json

{"description": "Sample text description",
"raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"issueCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"revokeCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"requestProtectionMethod": "sharedSecret",
"responseProtectionMethod": "sharedSecret",
"sharedSecret": "string",
"signingCertificateUuid": "string",
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
},
"name": "Example CMP Profile",
"variant": "v2"
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"variant": "v2",
"description": "Sample text description",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"cmpUrl": "https://your-domain.com/api/v1/protocols/cmp/cmpProfile",
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"revokeCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"requestProtectionMethod": "sharedSecret",
"responseProtectionMethod": "sharedSecret",
"signingCertificate": {"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
},
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
}

Delete CMP Profile

path Parameters

cmpProfileUuid

required

string

CMP Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get list of CMP Profiles

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"variant": "v2",
"description": "Sample text description",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"cmpUrl": "https://your-domain.com/api/v1/protocols/cmp/cmpProfile"
}
]

Create CMP Profile

Request Body schema: application/json
required

description	string Description of the CMP Profile
raProfileUuid	string RA Profile UUID that the CMP Profile is associated with
	Array of objects (RequestAttribute) List of Attributes to issue Certificate for the associated RA Profile. Required when raProfileUuid is provided
	Array of objects (RequestAttribute) List of Attributes to revoke Certificate for the associated RA Profile. Required when raProfileUuid is provided
	Array of objects (RequestAttribute) List of Custom Attributes for CMP Profile
requestProtectionMethod required	string (ProtectionMethod) Enum: "sharedSecret" "signature" Protection Method for the CMP Request
responseProtectionMethod required	string (ProtectionMethod) Enum: "sharedSecret" "signature" Protection Method for the CMP Response
sharedSecret	string Shared secret for the CMP Request. Required when requestProtectionMethod is sharedSecret
signingCertificateUuid	string UUID of the Certificate to be used as signing certificate for CMP responses. Required when responseProtectionMethod is signature
	object (ProtocolCertificateAssociationsRequestDto) Associations to set for certificates issued by the protocol
name required	string non-empty Name of the CMP Profile
variant required	string Enum: "v2" "v2_3gpp" "v3" Variant of the CMP Profile

Responses

Request samples

Payload

Content type

application/json

{"description": "Sample text description",
"raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"issueCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"revokeCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"requestProtectionMethod": "sharedSecret",
"responseProtectionMethod": "sharedSecret",
"sharedSecret": "string",
"signingCertificateUuid": "string",
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
},
"name": "Example CMP Profile",
"variant": "v2"
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"variant": "v2",
"description": "Sample text description",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"cmpUrl": "https://your-domain.com/api/v1/protocols/cmp/cmpProfile",
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"revokeCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"requestProtectionMethod": "sharedSecret",
"responseProtectionMethod": "sharedSecret",
"signingCertificate": {"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
},
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
}

Update RA Profile for CMP Profile

path Parameters

cmpProfileUuid required	string CMP Profile UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable CMP Profile

path Parameters

cmpProfileUuid

required

string

CMP Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable CMP Profile

path Parameters

cmpProfileUuid

required

string

CMP Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable multiple CMP Profiles

Request Body schema: application/json
required

CMP Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable multiple CMP Profile

Request Body schema: application/json
required

CMP Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get list of certificates eligible for signing of CMP responses

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
}
]

Delete multiple CMP Profiles

Request Body schema: application/json
required

CMP Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Force delete multiple CMP Profiles

Request Body schema: application/json
required

CMP Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
404
422

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Discovery Management

Discovery Management API

Create Discovery

Request Body schema: application/json
required

name required	string Discovery name
required	Array of objects (RequestAttribute) List of Attributes for Discovery
	Array of objects (RequestAttribute) List of Custom Attributes
connectorUuid required	string Discovery Provider UUID
kind required	string Discovery Kind
triggers	Array of strings <uuid> [ items <uuid > ] List of triggers to be triggered after the discovery is finished, triggers will be evaluated in given order

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"connectorUuid": "string",
"kind": "string",
"triggers": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"uuid": "string"
}

Delete Multiple Discoveries

Request Body schema: application/json
required

Discovery UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Schedule Discovery

Request Body schema: application/json
required

jobName	string
cronExpression	string
oneTime	boolean
	object (DiscoveryDto)

Responses

Request samples

Payload

Content type

application/json

{"jobName": "string",
"cronExpression": "string",
"oneTime": true,
"request": {"name": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"connectorUuid": "string",
"kind": "string",
"triggers": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
}

Response samples

Content type

application/json

{"uuid": "string"
}

List Discovery

Request Body schema: application/json
required

	Array of objects (SearchFilterRequestDto) Certificate filter input
itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": null
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

200
400
403
502
503

Content type

application/json

{"discoveries": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"kind": "IP-HostName",
"status": "inProgress",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"totalCertificatesDiscovered": 0,
"connectorUuid": "string",
"connectorName": "string"
}
],
"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0
}

Discovery Details

path Parameters

uuid

required

string

Discovery UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"kind": "IP-HostName",
"status": "inProgress",
"connectorStatus": "inProgress",
"message": "Failed due to network connectivity issues",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"totalCertificatesDiscovered": 0,
"connectorTotalCertificatesDiscovered": 0,
"connectorUuid": "string",
"connectorName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"triggers": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "event",
"resource": "NONE",
"ignoreTrigger": true,
"event": "certificate_status_changed"
}
]
}

Delete Discovery

path Parameters

uuid

required

string

Discovery UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Discovery Details

path Parameters

uuid

required

string

Discovery UUID

query Parameters

newlyDiscovered	boolean
itemsPerPage	integer <int32> Default: 10
pageNumber	integer <int32> Default: 0

Responses

Response samples

Content type

application/json

{"certificates": [{"uuid": "string",
"inventoryUuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"fingerprint": "string",
"certificateContent": "string",
"newlyDiscovered": true,
"processed": true,
"processedError": "string"
}
],
"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0
}

Get Discovery searchable fields information

Responses

Response samples

200
400
403
502
503

Content type

application/json

[{"filterFieldSource": "meta",
"searchFieldData": [{"fieldIdentifier": "string",
"fieldLabel": "string",
"type": "string",
"conditions": ["EQUALS"
],
"platformEnum": "Resource",
"attributeContentType": "string",
"value": null,
"multiValue": true
}
]
}
]

ACME Profile Management

ACME Profile Management API

Get details of ACME Profile

path Parameters

uuid

required

string

ACME Profile UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"description": "Sample description",
"termsOfServiceUrl": "https://sample-url.com/termsOfService",
"websiteUrl": "https://sample-company.com",
"dnsResolverIp": "8.8.8.8",
"dnsResolverPort": "53",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"retryInterval": 30,
"termsOfServiceChangeDisable": false,
"validity": 36000,
"directoryUrl": "https://some-server.com/api/v1/protocols/acme/profile1/directory",
"termsOfServiceChangeUrl": "https://some-company.com/termsOfService/change",
"requireContact": true,
"requireTermsOfService": true,
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"revokeCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
}

Edit ACME Profile

path Parameters

uuid

required

string

ACME Profile UUID

Request Body schema: application/json
required

description	string Description of the ACME Profile
termsOfServiceUrl	string Terms of Service URL
websiteUrl	string Website URL
dnsResolverIp	string Default: "System Default" DNS Resolver IP address
dnsResolverPort	string Default: "53" DNS Resolver port number
raProfileUuid	string RA Profile UUID
retryInterval	integer <int32> Default: 30 Retry interval for the Orders
termsOfServiceChangeDisable	boolean Default: false Disable new Orders due to change in Terms of Service
termsOfServiceChangeUrl	string Changes of Terms of Service URL
validity	integer <int32> Default: 36000 Order Validity
required	Array of objects (RequestAttribute) List of Attributes to issue Certificate
required	Array of objects (RequestAttribute) List of Attributes to revoke Certificate
requireContact	boolean Default: false Require contact information for new Account
requireTermsOfService	boolean Default: false Require new Account to agree on Terms of Service
	Array of objects (RequestAttribute) List of Custom Attributes
	object (ProtocolCertificateAssociationsRequestDto) Associations to set for certificates issued by the protocol

Responses

Request samples

Payload

Content type

application/json

{"description": "Sample description",
"termsOfServiceUrl": "https://sample-url.com/termsOfService",
"websiteUrl": "https://sample-url.com",
"dnsResolverIp": "8.8.8.8",
"dnsResolverPort": "53",
"raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"retryInterval": 60,
"termsOfServiceChangeDisable": false,
"termsOfServiceChangeUrl": "https://sample-url.com/termsOfService/change",
"validity": 3000,
"issueCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"revokeCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"requireContact": true,
"requireTermsOfService": false,
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"description": "Sample description",
"termsOfServiceUrl": "https://sample-url.com/termsOfService",
"websiteUrl": "https://sample-company.com",
"dnsResolverIp": "8.8.8.8",
"dnsResolverPort": "53",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"retryInterval": 30,
"termsOfServiceChangeDisable": false,
"validity": 36000,
"directoryUrl": "https://some-server.com/api/v1/protocols/acme/profile1/directory",
"termsOfServiceChangeUrl": "https://some-company.com/termsOfService/change",
"requireContact": true,
"requireTermsOfService": true,
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"revokeCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
}

Delete ACME Profile

path Parameters

uuid

required

string

ACME Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get list of ACME Profiles

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": false,
"description": "Some description",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"directoryUrl": "https://some-server.com/api/v1/protocols/acme/profile1/directory"
}
]

Create ACME Profile

Request Body schema: application/json
required

name required	string Name of the ACME Profile
description	string Description of the ACME Profile
termsOfServiceUrl	string Terms of Service URL
websiteUrl	string Website URL
dnsResolverIp	string Default: "System Default" DNS Resolver IP address
dnsResolverPort	string Default: "53" DNS Resolver port number
raProfileUuid	string RA Profile UUID
retryInterval	integer <int32> Default: 30 Retry interval for the Orders
validity	integer <int32> Default: 36000 Order Validity
required	Array of objects (RequestAttribute) List of Attributes to issue Certificate
required	Array of objects (RequestAttribute) List of Attributes to revoke Certificate
requireContact	boolean Default: false Require contact information for new Account
requireTermsOfService	boolean Default: false Require new Account to agree on Terms of Service
	Array of objects (RequestAttribute) List of Custom Attributes
	object (ProtocolCertificateAssociationsRequestDto) Associations to set for certificates issued by the protocol

Responses

Request samples

Payload

Content type

application/json

{"name": "Profile Name 1",
"description": "Sample description",
"termsOfServiceUrl": "https://sample-url.com/termsOfService",
"websiteUrl": "https://sample-url.com",
"dnsResolverIp": "8.8.8.8",
"dnsResolverPort": "53",
"raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"retryInterval": 60,
"validity": 3000,
"issueCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"revokeCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"requireContact": true,
"requireTermsOfService": false,
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "string"
}

Update RA Profile for ACME Profile

path Parameters

uuid required	string ACME Profile UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable ACME Profile

path Parameters

uuid

required

string

ACME Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable ACME Profile

path Parameters

uuid

required

string

ACME Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable multiple ACME Profiles

Request Body schema: application/json
required

ACME Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Disable multiple ACME Profile

Request Body schema: application/json
required

ACME Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Delete multiple ACME Profiles

Request Body schema: application/json
required

ACME Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Force delete multiple ACME Profiles

Request Body schema: application/json
required

ACME Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
422

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Compliance Profile Management v2

Compliance Profile Management v2 API

Details of a Compliance Profile

path Parameters

uuid

required

string <uuid>

Compliance Profile UUID

Responses

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"internalRules": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"groupUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
],
"providerRules": [{"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"connectorName": "string",
"kind": "string",
"rules": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"groupUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
],
"groups": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample group description",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE"
}
]
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Update Compliance Profile

path Parameters

uuid

required

string <uuid>

Compliance Profile UUID

Request Body schema: application/json
required

description	string Description of the Compliance Profile
internalRules	Array of strings <uuid> unique [ items <uuid > ] UUIDs of internal rules to be associated with the Compliance Profile. Profiles can be created without rules and can be added later.
	Array of objects (ProviderComplianceRulesRequestDto) Provider rules to be associated with the Compliance Profile. Profiles can be created without rules and can be added later.
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"description": "Profile 1",
"internalRules": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"providerRules": [{"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"kind": "string",
"rules": [{"uuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"groups": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"internalRules": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"groupUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
],
"providerRules": [{"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"connectorName": "string",
"kind": "string",
"rules": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"groupUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
],
"groups": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample group description",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE"
}
]
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Delete Compliance Profile

path Parameters

uuid

required

string <uuid>

Compliance Profile UUID

Responses

Update Compliance internal rule

path Parameters

internalRuleUuid

required

string <uuid>

Compliance internal rule UUID

Request Body schema: application/json
required

name required	string non-empty Name of the compliance internal rule
description	string Description of the compliance internal rule
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the compliance internal rule
required	Array of objects (ConditionItemRequestDto) non-empty List of the condition items to add to compliance internal rule

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"resource": "NONE",
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"kind": "string",
"groupUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}

Delete Compliance internal rule

path Parameters

internalRuleUuid

required

string <uuid>

Compliance internal rule UUID

Responses

List of available Compliance Profiles

Responses

Response samples

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"providerRulesCount": 0,
"providerGroupsCount": 0,
"internalRulesCount": 0,
"associations": 0
}
]

Add Compliance Profile

Request Body schema: application/json
required

description	string Description of the Compliance Profile
internalRules	Array of strings <uuid> unique [ items <uuid > ] UUIDs of internal rules to be associated with the Compliance Profile. Profiles can be created without rules and can be added later.
	Array of objects (ProviderComplianceRulesRequestDto) Provider rules to be associated with the Compliance Profile. Profiles can be created without rules and can be added later.
	Array of objects (RequestAttribute) List of Custom Attributes
name required	string non-empty Name of the Compliance Profile

Responses

Request samples

Payload

Content type

application/json

{"description": "Profile 1",
"internalRules": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"providerRules": [{"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"kind": "string",
"rules": [{"uuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"groups": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"name": "Profile 1"
}

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"internalRules": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"groupUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
],
"providerRules": [{"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"connectorName": "string",
"kind": "string",
"rules": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"groupUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
],
"groups": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample group description",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE"
}
]
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Delete multiple Compliance Profiles

Request Body schema: application/json
required

Compliance Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Get Compliance rules

Lists compliance rules. If provider UUID is sent (also kind is required) then provider rules are listed, otherwise lists internal rules

query Parameters

connectorUuid	string <uuid>
kind	string
resource	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"
type	string
format	string

Responses

Response samples

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"kind": "string",
"groupUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]

Create Compliance internal rule

Request Body schema: application/json
required

name required	string non-empty Name of the compliance internal rule
description	string Description of the compliance internal rule
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the compliance internal rule
required	Array of objects (ConditionItemRequestDto) non-empty List of the condition items to add to compliance internal rule

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"resource": "NONE",
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"kind": "string",
"groupUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}

Add/remove compliance rule to/from Compliance Profile

If provider UUID is sent (also kind is required) then provider rules is handled, otherwise handling internal rule

path Parameters

uuid

required

string <uuid>

Compliance Profile UUID

Request Body schema: application/json
required

removal required	boolean Indicates if removing or adding rule with UUID specified in request
ruleUuid required	string <uuid> UUID of the rule
connectorUuid	string <uuid> UUID of the Compliance Provider
kind	string Kind of the Compliance Provider
	Array of objects (RequestAttribute) Attributes for the rule

Responses

Request samples

Payload

Content type

application/json

{"removal": false,
"ruleUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"connectorUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"kind": "default",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

422

Content type

*/*

[
  "Error Message 1",
  "Error Message 2"
]

Add/remove group to/from Compliance Profile

path Parameters

uuid

required

string <uuid>

Compliance Profile UUID

Request Body schema: application/json
required

removal required	boolean Indicates if removing or adding group with UUID specified in request
groupUuid required	string <uuid> UUID of the group
connectorUuid required	string <uuid> UUID of the Compliance Provider
kind required	string Kind of the Compliance Provider

Responses

Request samples

Payload

Content type

application/json

{"removal": false,
"groupUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"connectorUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"kind": "default"
}

Response samples

422

Content type

*/*

[
  "Error Message 1",
  "Error Message 2"
]

Disassociate Compliance Profile from specified resource object

path Parameters

uuid required	string <uuid> Compliance Profile UUID
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Example: raProfiles Resource
associationObjectUuid required	string <uuid> Association object UUID

Responses

Response samples

422

Content type

*/*

[
  "Error Message 1",
  "Error Message 2"
]

Associate Compliance Profile to specified resource object

path Parameters

uuid required	string <uuid> Compliance Profile UUID
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Example: raProfiles Resource
associationObjectUuid required	string <uuid> Association object UUID

Responses

Response samples

422

Content type

*/*

[
  "Error Message 1",
  "Error Message 2"
]

Get associations of Compliance Profile

path Parameters

uuid

required

string <uuid>

Compliance Profile UUID

Responses

Response samples

Content type

application/json

[{"resource": "NONE",
"objectUuid": "2dcc528b-9e16-46c6-877e-74eae258173f",
"name": "Name"
}
]

Get Compliance groups

query Parameters

connectorUuid required	string <uuid>
kind required	string
resource	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Responses

Response samples

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample group description",
"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"kind": "string",
"resource": "NONE"
}
]

Get Compliance group rules

path Parameters

groupUuid

required

string <uuid>

query Parameters

connectorUuid required	string <uuid>
kind required	string

Responses

Response samples

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"kind": "string",
"groupUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]

Get associated Compliance Profiles for resource object

path Parameters

resource

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Example: raProfiles

Resource

associationObjectUuid

required

string <uuid>

Association object UUID

Responses

Response samples

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"providerRulesCount": 0,
"providerGroupsCount": 0,
"internalRulesCount": 0,
"associations": 0
}
]

Force delete Compliance Profiles

Request Body schema: application/json
required

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Approval profile Inventory

Approval profile Inventory API

Get Approval Profile Details

path Parameters

uuid

required

string

Approval profile UUID

query Parameters

version

integer <int32>

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"name": "ApprovalProfile1",
"version": 1,
"description": "Detail description of the approval profile",
"expiry": 24,
"numberOfSteps": 2,
"associations": 0,
"approvalSteps": [{"userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
"roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
"groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
"description": "string",
"order": 0,
"requiredApprovals": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"username": "string",
"roleName": "string",
"groupName": "string"
}
]
}

Edit an Approval profile

path Parameters

uuid

required

string

Approval profile UUID

Request Body schema: application/json
required

description	string Description of the Approval profile
expiry	integer <int32> Expiration of the Approval profile in hours
required	Array of objects (ApprovalStepRequestDto) List of Approval steps for the Approval profile

Responses

Request samples

Payload

Content type

application/json

{"description": "Detail description of the approval profile",
"expiry": 24,
"approvalSteps": [{"userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
"roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
"groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
"description": "string",
"order": 0,
"requiredApprovals": 0
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

{"uuid": "string"
}

Delete an approval profile

path Parameters

uuid

required

string

Approval profile UUID

Responses

Response samples

400
403
404
422

Content type

application/json

{"message": "Error message"
}

List Approval Profiles

query Parameters

itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Response samples

200
400
403

Content type

application/json

{"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0,
"approvalProfiles": [{"uuid": "string",
"name": "ApprovalProfile1",
"version": 1,
"description": "Detail description of the approval profile",
"expiry": 24,
"numberOfSteps": 2,
"associations": 0
}
]
}

Create a Approval profile

Request Body schema: application/json
required

name required	string Name of the Approval profile
description	string Description of the Approval profile
enabled required	boolean Enable of the Approval profile
expiry	integer <int32> Expiration of the Approval profile in hours
required	Array of objects (ApprovalStepRequestDto) List of Approval steps for the Approval profile

Responses

Request samples

Payload

Content type

application/json

{"name": "ApprovalProfile1",
"description": "Detail description of the approval profile",
"enabled": true,
"expiry": 24,
"approvalSteps": [{"userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
"roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
"groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
"description": "string",
"order": 0,
"requiredApprovals": 0
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

{"uuid": "string"
}

Compliance Management v2

Compliance Management v2 API

Initiate compliance check for requested compliance profiles

query Parameters

resource

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Filter objects checked by compliance based on its resource and evaluate only rules applicable to that resource

type

string

Example: type=X.509

Filter objects checked by compliance based on its type and evaluate only rules applicable to that resource type

Request Body schema: application/json
required

Compliance Profile UUIDs

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Initiate compliance Check for requested resource objects

path Parameters

resource

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Example: raProfiles

Resource

Request Body schema: application/json
required

Resource object UUIDs

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Get the latest compliance check result for the specified resource object

path Parameters

resource

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Example: raProfiles

Resource

objectUuid

required

string <uuid>

Object UUID

Responses

Response samples

Content type

application/json

{"status": "not_checked",
"timestamp": "2019-08-24T14:15:22Z",
"message": "string",
"failedRules": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"status": "ok",
"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"connectorName": "string",
"kind": "string",
"resource": "NONE",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
]
}

Initiate compliance Check for requested resource object

path Parameters

resource

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Example: raProfiles

Resource

objectUuid

required

string <uuid>

Object UUID

Responses

Workflow Actions Management

Workflow Actions Management API

Get Execution Details

path Parameters

executionUuid

required

string

Execution UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}

Update Execution

path Parameters

executionUuid

required

string

Execution UUID

Request Body schema: application/json
required

description	string Description of the execution
required	Array of objects (ExecutionItemRequestDto) List of the execution items to add to execution

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"data": null
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}

Delete Execution

path Parameters

executionUuid

required

string

Execution UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Action Details

path Parameters

actionUuid

required

string

Action UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"executions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
]
}

Update Action

path Parameters

actionUuid

required

string

Action UUID

Request Body schema: application/json
required

description	string Description of the action
executionsUuids required	Array of strings List of UUIDs of existing executions to add to the action

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"executionsUuids": ["string"
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"executions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
]
}

Delete Action

path Parameters

actionUuid

required

string

Action UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List executions

query Parameters

resource

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
]

Create Execution

Request Body schema: application/json
required

name required	string Name of the execution
description	string Description of the execution
type required	string (ExecutionType) Enum: "setField" "sendNotification" Type of the execution
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the execution
required	Array of objects (ExecutionItemRequestDto) List of the execution items to add to execution

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"data": null
}
]
}

Response samples

201
400
403

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}

List Actions

query Parameters

resource

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE"
}
]

Create Action

Request Body schema: application/json
required

name required	string Name of the action
description	string Description of the action
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the action
executionsUuids required	Array of strings List of UUIDs of existing executions to add to the action

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"resource": "NONE",
"executionsUuids": ["string"
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"executions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "setField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"notificationProfileUuid": "string",
"notificationProfileName": "string",
"data": null
}
]
}
]
}

Custom Attributes

Custom Attributes API

Custom Attribute details

path Parameters

uuid

required

string

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"name": "string",
"contentType": "string",
"description": "string",
"enabled": true,
"protectionLevel": "none",
"type": "data",
"label": "Attribute Name",
"required": true,
"visible": true,
"group": "requiredAttributes",
"readOnly": false,
"list": false,
"multiSelect": false,
"content": [{"contentType": "string",
"reference": "string",
"data": true
}
],
"resources": ["NONE"
]
}

Edit Custom Attribute

path Parameters

uuid

required

string

Attribute UUID

Request Body schema: application/json
required

description	string Attribute description
label required	string Friendly name of the the Attribute
visible	boolean Default: true Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user.
group	string Group of the Attribute, used for the logical grouping of the Attribute
required	boolean Default: false Boolean determining if the Attribute is required. If true, the Attribute must be provided.
readOnly	boolean Default: false Boolean determining if the Attribute is read only. If true, the Attribute content cannot be changed.
list	boolean Default: false Boolean determining if the Attribute contains list of values in the content
multiSelect	boolean Default: false Boolean determining if the Attribute can have multiple values
protectionLevel	string (ProtectionLevel) Enum: "none" "encrypted" Protection level of the attribute
	Array of (BaseAttributeContentDtoV2 (BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object))) or BaseAttributeContentDtoV3 (object) (AttributeContent) Predefined content for the attribute if needed. The content of the Attribute must satisfy the type
resources	Array of strings (Resource) Items Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" List of resource to be associated with the custom attribute

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"content": [{"contentType": "string",
"reference": "string",
"data": true
}
],
"resources": ["NONE"
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"name": "string",
"contentType": "string",
"description": "string",
"enabled": true,
"protectionLevel": "none",
"type": "data",
"label": "Attribute Name",
"required": true,
"visible": true,
"group": "requiredAttributes",
"readOnly": false,
"list": false,
"multiSelect": false,
"content": [{"contentType": "string",
"reference": "string",
"data": true
}
],
"resources": ["NONE"
]
}

Delete Custom Attribute

path Parameters

uuid

required

string

Custom Attribute UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List Custom Attributes

query Parameters

attributeContentType

string (AttributeContentType)

Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource"

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "string",
"name": "string",
"contentType": "string",
"description": "string",
"enabled": true,
"protectionLevel": "none",
"resources": ["NONE"
]
}
]

Create Custom Attribute

Request Body schema: application/json
required

name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Attribute Content Type
description	string Attribute description
label required	string Friendly name of the the Attribute
visible	boolean Default: true Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user.
group	string Group of the Attribute, used for the logical grouping of the Attribute
required	boolean Default: false Boolean determining if the Attribute is required. If true, the Attribute must be provided.
readOnly	boolean Default: false Boolean determining if the Attribute is read only. If true, the Attribute content cannot be changed.
list	boolean Default: false Boolean determining if the Attribute contains list of values in the content
multiSelect	boolean Default: false Boolean determining if the Attribute can have multiple values
	Array of (BaseAttributeContentDtoV2 (BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object))) or BaseAttributeContentDtoV3 (object) (AttributeContent) Predefined content for the attribute if needed. The content of the Attribute must satisfy the type
protectionLevel	string (ProtectionLevel) Enum: "none" "encrypted" Protection level of the attribute
resources	Array of strings (Resource) Items Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" List of resource to be associated with the custom attribute

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"contentType": "string",
"description": "string",
"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"content": [{"contentType": "string",
"reference": "string",
"data": true
}
],
"protectionLevel": "none",
"resources": ["NONE"
]
}

Response samples

201
400
403

Content type

application/json

{"uuid": "string"
}

Delete multiple Custom Attributes

Request Body schema: application/json
required

Attribute UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Associate Custom Attribute to Resource

path Parameters

uuid

required

string <uuid>

Custom Attribute UUID

Request Body schema: application/json
required

List of Resources

Array

string

Responses

Request samples

Payload

Content type

application/json

["raProfiles",
"authorities"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable Custom Attribute

path Parameters

uuid

required

string

Custom Attribute UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable Custom Attribute

path Parameters

uuid

required

string

Custom Attribute UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Delete Value of a Custom Attribute for a Resource

path Parameters

resourceName required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource Type
objectUuid required	string Object UUID
attributeUuid required	string Custom Attribute UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]

Update Value of a Custom Attribute for a Resource

path Parameters

resourceName required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource Type
objectUuid required	string Object UUID
attributeUuid required	string Custom Attribute UUID

Request Body schema: application/json
required

Array

One of

reference	string ContentV2 Reference
data required	boolean Boolean attribute value
contentType	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource"

Responses

Request samples

Payload

Content type

application/json

[{"contentType": "string",
"reference": "string",
"data": true
}
]

Response samples

200
400
403
404

Content type

application/json

[{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]

Enable multiple Custom Attributes

Request Body schema: application/json
required

Attribute UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Disable multiple Custom Attributes

Request Body schema: application/json
required

Attribute UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Get available resources for Custom Attributes

Responses

Response samples

200
400
403

Content type

application/json

["NONE"
]

Get Custom Attributes for a resource

path Parameters

resource

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Resource Name

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"extensibleList": false,
"protectionLevel": "none"
}
}
]

Internal Notification

Internal Notifications API that manages notifications for logged user in the platform. Note that this API does not manage nor trigger external notifications. For external notifications, please refer to the External Notification Management API.

List notifications for logged user

query Parameters

unread	boolean Default: false Show only unread notifications
itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Response samples

200
400
403

Content type

application/json

{"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0,
"items": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"message": "string",
"detail": "string",
"readAt": "2019-08-24T14:15:22Z",
"sentAt": "2019-08-24T14:15:22Z",
"targetObjectType": "NONE",
"targetObjectIdentification": ["string"
]
}
]
}

Delete a list of notifications for logged user

Request Body schema: application/json
required

Notifications UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Mark a list of notifications as read for logged user

Request Body schema: application/json
required

Notifications UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Delete a notification for logged user

path Parameters

uuid

required

string

Notification UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Mark notification as read for logged user

path Parameters

uuid

required

string

Notification UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Connector Management v2

Connector Management v2 API

Get details of a Connector

path Parameters

uuid

required

string <uuid>

Connector UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"version": "v1",
"url": "http://network-discovery-provider:8080",
"status": "waitingForApproval",
"functionGroups": [{"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
],
"interfaces": [{"code": "info",
"version": "string",
"features": ["stateless"
]
}
],
"authType": "none",
"authAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Edit a Connector

path Parameters

uuid

required

string <uuid>

Connector UUID

Request Body schema: application/json
required

url required	string URL of the Connector to connect
authType required	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttribute) List of authentication Attributes. Required if the authentication type is not NONE
required	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"url": "http://network-discovery-provider:8080",
"authType": "none",
"authAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"version": "v1",
"url": "http://network-discovery-provider:8080",
"status": "waitingForApproval",
"functionGroups": [{"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
],
"interfaces": [{"code": "info",
"version": "string",
"features": ["stateless"
]
}
],
"authType": "none",
"authAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Delete a Connector

path Parameters

uuid

required

string <uuid>

Connector UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Create a new Connector

Request Body schema: application/json
required

name required	string non-empty Name of the Connector
version required	string (ConnectorVersion) Enum: "v1" "v2" Version of the Connector.
url required	string URL of the Connector to connect
authType required	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttribute) List of authentication Attributes. Required if the authentication type is not NONE
required	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "Connector1",
"version": "v1",
"url": "http://network-discovery-provider:8080",
"authType": "none",
"authAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"version": "v1",
"url": "http://network-discovery-provider:8080",
"status": "waitingForApproval",
"functionGroups": [{"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
],
"interfaces": [{"code": "info",
"version": "string",
"features": ["stateless"
]
}
],
"authType": "none",
"authAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Reconnect Connector

path Parameters

uuid

required

string <uuid>

Connector UUID

Responses

Response samples

Content type

application/json

Example

v1

{"version": "v1",
"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"errorMessage": "string",
"functionGroups": [{"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
]
}

Reconnect multiple Connectors

Request Body schema: application/json
required

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

List Connectors

Request Body schema: application/json
required

	Array of objects (SearchFilterRequestDto) Certificate filter input
itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": null
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

Content type

application/json

{"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"version": "v1",
"url": "http://network-discovery-provider:8080",
"status": "waitingForApproval"
}
],
"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0
}

Force Delete multiple Connectors

Request Body schema: application/json
required

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Delete multiple Connectors

Request Body schema: application/json
required

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Connect to a Connector

Request Body schema: application/json
required

url required	string URL of the Connector to connect
uuid	string UUID of the Connector. Mandatory if connection is needed for the same Connector
authType required	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttribute) List of authentication Attributes. Required if the authentication type is not NONE

Responses

Request samples

Payload

Content type

application/json

{"url": "http://network-discovery-provicer:8080",
"uuid": "string",
"authType": "none",
"authAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

[{"version": "v1",
"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"errorMessage": "string",
"functionGroups": [{"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
]
}
]

Approve multiple Connector

Request Body schema: application/json
required

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Approve a Connector

path Parameters

uuid

required

string <uuid>

Connector UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Get Info about Connector

path Parameters

uuid

required

string <uuid>

Connector UUID

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"version": "string",
"description": "string",
"metadata": {"property1": null,
"property2": null
}
}

Check Health of a Connector

path Parameters

uuid

required

string <uuid>

Connector UUID

Responses

Response samples

Content type

application/json

{"status": "UP",
"components": {"property1": {"status": "UP",
"details": {"property1": null,
"property2": null
}
},
"property2": {"status": "UP",
"details": {"property1": null,
"property2": null
}
}
}
}

Get Connectors searchable fields information

Responses

Response samples

Content type

application/json

[{"filterFieldSource": "meta",
"searchFieldData": [{"fieldIdentifier": "string",
"fieldLabel": "string",
"type": "string",
"conditions": ["EQUALS"
],
"platformEnum": "Resource",
"attributeContentType": "string",
"value": null,
"multiValue": true
}
]
}
]

Token Profile Management

Token Profile Management API

Details of Token Profile

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Token Profile UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"tokenInstanceStatus": "Connected",
"enabled": true,
"usages": ["sign"
]
}

Edit Token Profile

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Token Profile UUID

Request Body schema: application/json
required

description	string Description of Token Profile
required	Array of objects (RequestAttribute) List of Attributes for Token Profile
	Array of objects (RequestAttribute) List of Custom Attributes
enabled	boolean Enabled flag - true = enabled; false = disabled
usage	Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"enabled": true,
"usage": ["sign"
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"tokenInstanceStatus": "Connected",
"enabled": true,
"usages": ["sign"
]
}

Delete Token Profile

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Token Profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Update Key Usage

path Parameters

tokenInstanceUuid required	string Token Instance UUID
tokenProfileUuid required	string Token Profile UUID

Request Body schema: application/json
required

usage

required

Array of strings (KeyUsage)

Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap"

Usages for the Key

Responses

Request samples

Payload

Content type

application/json

{"usage": ["sign"
]
}

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Update Key Usages for Multiple Token Profiles

Request Body schema: application/json
required

usage required	Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key
uuids required	Array of strings <uuid> [ items <uuid > ] Token Profile UUIDs

Responses

Request samples

Payload

Content type

application/json

{"usage": ["sign"
],
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403
502
503

Content type

application/json

{"message": "Error message"
}

Create Token Profile

path Parameters

tokenInstanceUuid

required

string

Token Instance UUID

Request Body schema: application/json
required

name required	string Token Profile name
description	string Token Profile description
required	Array of objects (RequestAttribute) List of Attributes to create Token Profile
	Array of objects (RequestAttribute) List of Custom Attributes
enabled	boolean Default: false Enabled flag - true = enabled; false = disabled
usage	Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"enabled": false,
"usage": ["sign"
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"tokenInstanceStatus": "Connected",
"enabled": true,
"usages": ["sign"
]
}

Enable Token Profile

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Token Profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Disable Token Profile

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Token Profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Enable multiple Token Profiles

Request Body schema: application/json
required

Token Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
502
503

Content type

application/json

{"message": "Error message"
}

Disable multiple Token Profiles

Request Body schema: application/json
required

Token Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
502
503

Content type

application/json

{"message": "Error message"
}

List of available Token Profiles

query Parameters

enabled

boolean

Responses

Response samples

200
400
403
502
503

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"tokenInstanceStatus": "Connected",
"enabled": true,
"usages": ["sign"
]
}
]

Delete multiple Token Profiles

Request Body schema: application/json
required

Token Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
422
502
503

Content type

application/json

{"message": "Error message"
}

Delete Token Profile

path Parameters

uuid

required

string

Token Profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

CBOM management

CBOM management API

List CBOMs

Request Body schema: application/json
required

	Array of objects (SearchFilterRequestDto) Certificate filter input
itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": null
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

200
400
403

Content type

application/json

{"items": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"createdAt": "2019-08-24T14:15:22Z",
"serialNumber": "string",
"version": "string",
"specVersion": "string",
"timestamp": "2019-08-24T14:15:22Z",
"source": "string",
"algorithms": 0,
"certificates": 0,
"protocols": 0,
"cryptoMaterial": 0,
"totalAssets": 0
}
],
"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0
}

Upload CBOM

Request Body schema: application/json
required

required	object Raw JSON content of CBOM document
	Array of objects (RequestAttribute) Custom attributes

Responses

Request samples

Payload

Content type

application/json

{"content": {"property1": null,
"property2": null
},
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

201
400
403

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"createdAt": "2019-08-24T14:15:22Z",
"serialNumber": "string",
"version": "string",
"specVersion": "string",
"timestamp": "2019-08-24T14:15:22Z",
"source": "string",
"algorithms": 0,
"certificates": 0,
"protocols": 0,
"cryptoMaterial": 0,
"totalAssets": 0
}

CBOM detail

path Parameters

uuid

required

string <uuid>

CBOM entry UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"createdAt": "2019-08-24T14:15:22Z",
"serialNumber": "string",
"version": "string",
"specVersion": "string",
"timestamp": "2019-08-24T14:15:22Z",
"source": "string",
"algorithms": 0,
"certificates": 0,
"protocols": 0,
"cryptoMaterial": 0,
"totalAssets": 0,
"content": {"property1": null,
"property2": null
}
}

List CBOM versions

path Parameters

uuid

required

string <uuid>

CBOM entry UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"createdAt": "2019-08-24T14:15:22Z",
"serialNumber": "string",
"version": "string",
"specVersion": "string",
"timestamp": "2019-08-24T14:15:22Z",
"source": "string",
"algorithms": 0,
"certificates": 0,
"protocols": 0,
"cryptoMaterial": 0,
"totalAssets": 0
}
]

Get Cbom searchable fields information

Responses

Response samples

200
400
403

Content type

application/json

[{"filterFieldSource": "meta",
"searchFieldData": [{"fieldIdentifier": "string",
"fieldLabel": "string",
"type": "string",
"conditions": ["EQUALS"
],
"platformEnum": "Resource",
"attributeContentType": "string",
"value": null,
"multiValue": true
}
]
}
]

ACME Account Management

ACME Account Management API

Revoke multiple ACME Accounts

Request Body schema: application/json
required

ACME Account UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Details of ACME Account

path Parameters

acmeProfileUuid required	string ACME Profile UUID
acmeAccountUuid required	string ACME Account UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"accountId": "TtrgfYTR6F",
"uuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"enabled": false,
"totalOrders": 23,
"successfulOrders": 2,
"failedOrders": 239,
"pendingOrders": 24,
"validOrders": 23,
"processingOrders": 27,
"status": "valid",
"contact": ["mailto: someadmin@domain.com"
],
"termsOfServiceAgreed": true,
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"acmeProfileName": "ACME Profile 1",
"acmeProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002"
}

Revoke ACME Account

path Parameters

acmeProfileUuid required	string ACME Profile UUID
acmeAccountUuid required	string ACME Account UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable ACME Account

path Parameters

acmeProfileUuid required	string ACME Profile UUID
acmeAccountUuid required	string ACME Account UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable ACME Account

path Parameters

acmeProfileUuid required	string ACME Profile UUID
acmeAccountUuid required	string ACME Account UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable multiple ACME Accounts

Request Body schema: application/json
required

ACME Account UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable multiple ACME Accounts

Request Body schema: application/json
required

ACME Account UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List ACME Accounts

Responses

Response samples

200
400
403
404

Content type

application/json

[{"accountId": "HJAT6gc7i6",
"uuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"enabled": false,
"totalOrders": 4,
"status": "valid",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"acmeProfileName": "ACMEProfile1",
"acmeProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002"
}
]

Audit Log

Audit Log API

List Audit logs

Request Body schema: application/json
required

	Array of objects (SearchFilterRequestDto) Certificate filter input
itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": null
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

200
400
403

Content type

application/json

{"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0,
"items": [{"id": 0,
"version": "string",
"loggedAt": "2019-08-24T14:15:22Z",
"timestamp": "2019-08-24T14:15:22Z",
"module": "approvals",
"actor": {"type": "anonymous",
"authMethod": "none",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string"
},
"source": {"method": "string",
"path": "string",
"contentType": "string",
"ipAddress": "string",
"userAgent": "string"
},
"resource": {"type": "NONE",
"objects": [{"name": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
]
},
"affiliatedResource": {"type": "NONE",
"objects": [{"name": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
]
},
"operation": "unknown",
"operationResult": "success",
"message": "string",
"operationData": null,
"additionalData": {"property1": null,
"property2": null
}
}
]
}

Purge Audit logs

Request Body schema: application/json
required

Array

fieldSource required	string (FilterFieldSource) Enum: "meta" "custom" "data" "property" Field group of search filter
fieldIdentifier required	string Field identifier of search filter. List of available fields with their identifiers can be retrieved from corresponding endpoint `GET /v1/{resource}/search`, e.g.: GET /v1/certificates/search
condition required	string (FilterConditionOperator) Enum: "EQUALS" "NOT_EQUALS" "GREATER" "GREATER_OR_EQUAL" "LESSER" "LESSER_OR_EQUAL" "CONTAINS" "NOT_CONTAINS" "STARTS_WITH" "ENDS_WITH" "EMPTY" "NOT_EMPTY" "IN_NEXT" "IN_PAST" "MATCHES" "NOT_MATCHES" "COUNT_EQUAL" "COUNT_NOT_EQUAL" "COUNT_GREATER_THAN" "COUNT_LESS_THAN" Condition for the search filter
value	any Value to match

Responses

Request samples

Payload

Content type

application/json

[{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": null
}
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Export Audit logs

Request Body schema: application/json
required

Array

fieldSource required	string (FilterFieldSource) Enum: "meta" "custom" "data" "property" Field group of search filter
fieldIdentifier required	string Field identifier of search filter. List of available fields with their identifiers can be retrieved from corresponding endpoint `GET /v1/{resource}/search`, e.g.: GET /v1/certificates/search
condition required	string (FilterConditionOperator) Enum: "EQUALS" "NOT_EQUALS" "GREATER" "GREATER_OR_EQUAL" "LESSER" "LESSER_OR_EQUAL" "CONTAINS" "NOT_CONTAINS" "STARTS_WITH" "ENDS_WITH" "EMPTY" "NOT_EMPTY" "IN_NEXT" "IN_PAST" "MATCHES" "NOT_MATCHES" "COUNT_EQUAL" "COUNT_NOT_EQUAL" "COUNT_GREATER_THAN" "COUNT_LESS_THAN" Condition for the search filter
value	any Value to match

Responses

Request samples

Payload

Content type

application/json

[{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": null
}
]

Response samples

200
400
403

Content type

application/json

"string"

Get Audit logs searchable fields information

Responses

Response samples

200
400
403

Content type

application/json

[{"filterFieldSource": "meta",
"searchFieldData": [{"fieldIdentifier": "string",
"fieldLabel": "string",
"type": "string",
"conditions": ["EQUALS"
],
"platformEnum": "Resource",
"attributeContentType": "string",
"value": null,
"multiValue": true
}
]
}
]

Settings

Settings API

Get platform settings

Responses

Response samples

200
400
403

Content type

application/json

{"utils": {"utilsServiceUrl": "http://util-service:8080",
"cbomRepositoryUrl": "http://cbom-repository:8080"
},
"certificates": {"validation": {"enabled": true,
"frequency": 1,
"expiringThreshold": 1
}
}
}

Update platform settings

Request Body schema: application/json
required

	object (UtilsSettingsDto) Utils settings of the platform
	object (CertificateSettingsUpdateDto) Settings applicable to all certificates in inventory by default

Responses

Request samples

Payload

Content type

application/json

{"utils": {"utilsServiceUrl": "http://util-service:8080",
"cbomRepositoryUrl": "http://cbom-repository:8080"
},
"certificates": {"validation": {"enabled": true,
"frequency": 1,
"expiringThreshold": 30
}
}
}

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Get logging settings

Responses

Response samples

200
400
403

Content type

application/json

{"auditLogs": {"logAllModules": true,
"logAllResources": true,
"loggedModules": ["approvals"
],
"ignoredModules": ["approvals"
],
"loggedResources": ["NONE"
],
"ignoredResources": ["NONE"
],
"output": "NONE",
"verbose": true
},
"eventLogs": {"logAllModules": true,
"logAllResources": true,
"loggedModules": ["approvals"
],
"ignoredModules": ["approvals"
],
"loggedResources": ["NONE"
],
"ignoredResources": ["NONE"
]
}
}

Update logging settings

Request Body schema: application/json
required

required	object (AuditLoggingSettingsDto) Settings of audit logging
required	object (ResourceLoggingSettingsDto) Settings of event logging

Responses

Request samples

Payload

Content type

application/json

{"auditLogs": {"logAllModules": true,
"logAllResources": true,
"loggedModules": ["approvals"
],
"ignoredModules": ["approvals"
],
"loggedResources": ["NONE"
],
"ignoredResources": ["NONE"
],
"output": "NONE",
"verbose": true
},
"eventLogs": {"logAllModules": true,
"logAllResources": true,
"loggedModules": ["approvals"
],
"ignoredModules": ["approvals"
],
"loggedResources": ["NONE"
],
"ignoredResources": ["NONE"
]
}
}

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Get events settings

Responses

Response samples

200
400
403

Content type

application/json

{"eventsMapping": {"property1": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"property2": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
}

Update multiple events settings

Request Body schema: application/json
required

required

object

Map of triggers associated to event where key is resource event enum and value is list of trigger UUIDs

Responses

Request samples

Payload

Content type

application/json

{"eventsMapping": {"property1": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"property2": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
}

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Update single event settings

Request Body schema: application/json
required

event required	string (ResourceEvent) Enum: "certificate_status_changed" "certificate_action_performed" "certificate_discovered" "certificate_expiring" "certificate_not_compliant" "discovery_finished" "approval_requested" "approval_closed" "scheduled_job_finished" Resource event
triggerUuids required	Array of strings <uuid> [ items <uuid > ] List of triggers associated with event

Responses

Request samples

Payload

Content type

application/json

{"event": "certificate_status_changed",
"triggerUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Get authentication settings

Responses

Response samples

200
400
403

Content type

application/json

{"disableLocalhostUser": true,
"oauth2Providers": {"property1": {"name": "string",
"issuerUrl": "string",
"clientId": "string",
"clientSecret": "string",
"authorizationUrl": "string",
"tokenUrl": "string",
"jwkSetUrl": "string",
"jwkSet": "string",
"scope": ["string"
],
"logoutUrl": "string",
"postLogoutUrl": "string",
"userInfoUrl": "string",
"audiences": ["string"
],
"skew": 0,
"sessionMaxInactiveInterval": 900
},
"property2": {"name": "string",
"issuerUrl": "string",
"clientId": "string",
"clientSecret": "string",
"authorizationUrl": "string",
"tokenUrl": "string",
"jwkSetUrl": "string",
"jwkSet": "string",
"scope": ["string"
],
"logoutUrl": "string",
"postLogoutUrl": "string",
"userInfoUrl": "string",
"audiences": ["string"
],
"skew": 0,
"sessionMaxInactiveInterval": 900
}
}
}

Update authentication settings

Request Body schema: application/json
required

disableLocalhostUser required	boolean Disable using localhost user for requests from localhost
	Array of objects (OAuth2ProviderSettingsDto)

Responses

Request samples

Payload

Content type

application/json

{"disableLocalhostUser": true,
"oauth2Providers": [{"name": "string",
"issuerUrl": "string",
"clientId": "string",
"clientSecret": "string",
"authorizationUrl": "string",
"tokenUrl": "string",
"jwkSetUrl": "string",
"jwkSet": "string",
"scope": ["string"
],
"logoutUrl": "string",
"postLogoutUrl": "string",
"userInfoUrl": "string",
"audiences": ["string"
],
"skew": 0,
"sessionMaxInactiveInterval": 900
}
]
}

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Get OAuth2 Provider settings

path Parameters

providerName

required

string

OAuth2 Provider Name

Responses

Response samples

200
400
403

Content type

application/json

{"issuerUrl": "string",
"clientId": "string",
"clientSecret": "string",
"authorizationUrl": "string",
"tokenUrl": "string",
"jwkSetUrl": "string",
"jwkSet": "string",
"scope": ["string"
],
"logoutUrl": "string",
"postLogoutUrl": "string",
"userInfoUrl": "string",
"audiences": ["string"
],
"skew": 0,
"sessionMaxInactiveInterval": 900,
"name": "string",
"jwkSetKeys": [{"kid": "string",
"publicKey": "string",
"keyType": "string",
"algorithm": "string",
"use": "string"
}
]
}

Update OAuth2 Provider settings

path Parameters

providerName

required

string

OAuth2 Provider Name

Request Body schema: application/json
required

issuerUrl	string URL of issuer issuing authentication tokens. If provided, authentication via JWT token is enabled for this provider.
clientId	string The client ID used to identify the client application during the authorization process.
clientSecret	string The client secret used by the client application to authenticate with the authorization server.
authorizationUrl	string The URL where the authorization server redirects the user for login and authorization.
tokenUrl	string The URl used to exchange the authorization code or credentials for an access token.
jwkSetUrl	string The URL where the JSON Web Key Set (JWKS) containing the public keys used to verify JWT tokens can be retrieved.
jwkSet	string Base64 encoded JWK Set, provided in case JWK Set URL is not available
scope	Array of strings The list of scopes that define the access levels and permissions requested by the client application.
logoutUrl	string URL to end session on provider side.
postLogoutUrl	string URL that user will be redirected after logout from application.
userInfoUrl	string The URL containing information about user.
audiences	Array of strings A list of expected audiences for validating the issued tokens, used to match the intended recipients of the tokens.
skew	integer <int32> The allowed time skew, in seconds, for token validation. This accounts for clock differences between systems. Default value is 30 seconds.
sessionMaxInactiveInterval	integer <int32> Default: 900 Duration, in seconds, after which an inactive user's session will be terminated. Default value is 900 seconds.

Responses

Request samples

Payload

Content type

application/json

{"issuerUrl": "string",
"clientId": "string",
"clientSecret": "string",
"authorizationUrl": "string",
"tokenUrl": "string",
"jwkSetUrl": "string",
"jwkSet": "string",
"scope": ["string"
],
"logoutUrl": "string",
"postLogoutUrl": "string",
"userInfoUrl": "string",
"audiences": ["string"
],
"skew": 0,
"sessionMaxInactiveInterval": 900
}

Remove OAuth2 Provider

path Parameters

providerName

required

string

OAuth2 Provider Name

Responses

Certificate Inventory

Certificate Inventory API

List Certificates

Request Body schema: application/json
required

	Array of objects (SearchFilterRequestDto) Certificate filter input
itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request
includeArchived	boolean Include archived certificates

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": null
}
],
"itemsPerPage": 10,
"pageNumber": 1,
"includeArchived": true
}

Response samples

200
400
403
404

Content type

application/json

{"certificates": [{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
}
],
"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0
}

Update Group and/or Owner for multiple Certificates

In this operation, when the list of Certificate UUIDs are provided and the filter is left as null or undefined, then the change will be applied only to the list of Certificate UUIDs provided. When the filter is provided in the request, the list of UUIDs will be ignored and the change will be applied for the all the certificates that matches the filter criteria. To apply this change for all the Certificates in the inventory, provide an empty array "[]" for the value of "filters" in the request body

Request Body schema: application/json
required

groupUuids	Array of strings Certificate Groups UUIDs (set to empty list to remove certificate from all groups)
ownerUuid	string Certificate owner user UUID (set to empty string to remove owner of certificate)
raProfileUuid	string RA Profile UUID (set to empty string to remove certificate from RA profile)
certificateUuids	Array of strings List of Certificate UUIDs
	Array of objects (SearchFilterRequestDto) Certificate filter input

Responses

Request samples

Payload

Content type

application/json

{"groupUuids": ["string"
],
"ownerUuid": "string",
"raProfileUuid": "string",
"certificateUuids": ["string"
],
"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": null
}
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Upload a new Certificate

Request Body schema: application/json
required

certificate required	string Base64 Content of the Certificate
required	Array of objects (RequestAttribute) Custom Attributes for the Certificate

Responses

Request samples

Payload

Content type

application/json

{"certificate": "string",
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "string"
}

Delete multiple certificates

In this operation, when the list of Certificate UUIDs are provided and the filter is left as null or undefined, then the change will be applied only to the list of Certificate UUIDs provided. When the filter is provided in the request, the list of UUIDs will be ignored and the change will be applied for the all the certificates that matches the filter criteria. To apply this change for all the Certificates in the inventory, provide an empty array "[]" for the value of "filters" in the request body

Request Body schema: application/json
required

uuids	Array of strings List of Certificate UUIDs
	Array of objects (SearchFilterRequestDto) Certificate filter input

Responses

Request samples

Payload

Content type

application/json

{"uuids": ["string"
],
"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": null
}
]
}

Response samples

200
400
403
404
501

Content type

application/json

{"status": "SUCCESS",
"failedItem": 0,
"message": "string"
}

Submit certificate request

Request Body schema: application/json
required

raProfileUuid required	string <uuid> RA Profile UUID. Required if CSR is not uploaded
sourceCertificateUuid	string <uuid> Source certificate UUID to specify in case of renew/rekey operation
	Array of objects (RequestAttribute) List of attributes to create CSR. Required if CSR is not provided
	Array of objects (RequestAttribute) List of attributes to sign the CSR
	Array of objects (RequestAttribute) List of attributes to sign the alternative private key, in case of hybrid CSR
request	string Certificate signing request encoded as Base64 string
format	string (CertificateRequestFormat) Default: "pkcs10" Enum: "pkcs10" "crmf" Certificate signing request format
tokenProfileUuid	string <uuid> Token Profile UUID. Required if CSR is not uploaded
keyUuid	string <uuid> Key UUID. Required if CSR is not uploaded
altTokenProfileUuid	string <uuid> Token Profile UUID for the alternative key
altKeyUuid	string <uuid> Alternative Key UUID.
required	Array of objects (RequestAttribute) List of RA Profile related Attributes to issue Certificate
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"raProfileUuid": "b9278d9c-f0fb-4571-ad29-d552005d6e12",
"sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
"csrAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"signatureAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"altSignatureAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"request": "string",
"format": "pkcs10",
"tokenProfileUuid": "66f2e24c-4f07-496b-b5c4-6fe8a5e8361a",
"keyUuid": "a0e39a6c-fae3-43d6-99c3-a3620775a368",
"altTokenProfileUuid": "487a31a3-090d-4b19-9b24-0ff6d52ff0e9",
"altKeyUuid": "ae57c41d-5798-439d-bc96-b05c70b20ac1",
"issueAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false,
"extendedKeyUsage": ["string"
],
"keyUsage": ["digitalSignature"
],
"subjectType": "endEntity",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"certificateContent": "string",
"subjectAlternativeNames": {"property1": ["string"
],
"property2": ["string"
]
},
"locations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [null
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [null
],
"version": "v2"
}
]
}
],
"pushAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"csrAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
]
}
],
"nonCompliantRules": [{"connectorName": "Provider1",
"ruleName": "RuleName",
"ruleDescription": "Description sample",
"status": "ok",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"key": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"keyWrapperUuid": "string",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": null,
"data": null
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"associations": 0,
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"length": 0,
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"complianceStatus": "not_checked"
}
],
"associations": 0,
"complianceStatus": "not_checked"
},
"altKey": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"keyWrapperUuid": "string",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": null,
"data": null
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"associations": 0,
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"length": 0,
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"complianceStatus": "not_checked"
}
],
"associations": 0,
"complianceStatus": "not_checked"
},
"certificateRequest": {"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"certificateType": "X.509",
"certificateRequestFormat": "pkcs10",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"content": "string",
"commonName": "string",
"subjectDn": "string",
"subjectAlternativeNames": {"property1": ["string"
],
"property2": ["string"
]
},
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"signatureAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"altSignatureAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"keyUuid": "string",
"altKeyUuid": "string",
"complianceStatus": "not_checked"
},
"sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
"issueAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"revokeAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"relatedCertificates": [{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
}
],
"protocolInfo": {"protocol": "acme",
"protocolProfileUuid": "a286b9c7-97ed-44c6-a837-e8415ab11bf4",
"additionalProtocolUuid": "bcf08956-ad5e-4c4a-863d-293464f7e308"
}
}

Get Certificate Content

Request Body schema: application/json
required

Certificate UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
404
422

Content type

application/json

[{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"certificateContent": "string"
}
]

Initiate Certificate Compliance Check Deprecated

Request Body schema: application/json
required

certificateUuids

Array of strings

List of UUIDs of the Certificates

Responses

Request samples

Payload

Content type

application/json

{"certificateUuids": ["string"
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Certificate Details

path Parameters

uuid

required

string <uuid>

Certificate UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false,
"extendedKeyUsage": ["string"
],
"keyUsage": ["digitalSignature"
],
"subjectType": "endEntity",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"certificateContent": "string",
"subjectAlternativeNames": {"property1": ["string"
],
"property2": ["string"
]
},
"locations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [null
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [null
],
"version": "v2"
}
]
}
],
"pushAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"csrAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
]
}
],
"nonCompliantRules": [{"connectorName": "Provider1",
"ruleName": "RuleName",
"ruleDescription": "Description sample",
"status": "ok",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"key": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"keyWrapperUuid": "string",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": null,
"data": null
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"associations": 0,
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"length": 0,
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"complianceStatus": "not_checked"
}
],
"associations": 0,
"complianceStatus": "not_checked"
},
"altKey": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"keyWrapperUuid": "string",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": null,
"data": null
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"associations": 0,
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"length": 0,
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"complianceStatus": "not_checked"
}
],
"associations": 0,
"complianceStatus": "not_checked"
},
"certificateRequest": {"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"certificateType": "X.509",
"certificateRequestFormat": "pkcs10",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"content": "string",
"commonName": "string",
"subjectDn": "string",
"subjectAlternativeNames": {"property1": ["string"
],
"property2": ["string"
]
},
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"signatureAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"altSignatureAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"keyUuid": "string",
"altKeyUuid": "string",
"complianceStatus": "not_checked"
},
"sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
"issueAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"revokeAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"relatedCertificates": [{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
}
],
"protocolInfo": {"protocol": "acme",
"protocolProfileUuid": "a286b9c7-97ed-44c6-a837-e8415ab11bf4",
"additionalProtocolUuid": "bcf08956-ad5e-4c4a-863d-293464f7e308"
}
}

Delete a certificate

path Parameters

uuid

required

string <uuid>

Certificate UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Update Certificate Objects

path Parameters

uuid

required

string <uuid>

Certificate UUID

Request Body schema: application/json
required

groupUuids	Array of strings Certificate Groups UUIDs (set to empty list to remove certificate from all groups)
ownerUuid	string Certificate owner user UUID (set to empty string to remove owner of certificate)
raProfileUuid	string RA Profile UUID (set to empty string to remove certificate from RA profile)
trustedCa	boolean Mark CA certificate as trusted

Responses

Request samples

Payload

Content type

application/json

{"groupUuids": ["string"
],
"ownerUuid": "string",
"raProfileUuid": "string",
"trustedCa": true
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Unarchive a certificate

path Parameters

uuid

required

string <uuid>

Certificate UUID

Responses

Remove a source certificate association from the given certificate

path Parameters

uuid required	string <uuid> Certificate UUID
certificateUuid required	string <uuid> UUID of certificate to disassociate the certificate with

Responses

Associate a source certificate to the given certificate

path Parameters

uuid required	string <uuid> Certificate UUID
certificateUuid required	string <uuid> UUID of certificate to associate the certificate with

Responses

Archive a certificate

path Parameters

uuid

required

string <uuid>

Certificate UUID

Responses

Unarchive a list of certificates

Request Body schema: application/json
required

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Archive a list of certificates

Request Body schema: application/json
required

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Download Certificate

path Parameters

uuid required	string <uuid> Certificate UUID
certificateFormat required	string (CertificateFormat) Enum: "raw" "pkcs7" Certificate format

query Parameters

encoding

required

string (CertificateFormatEncoding)

Enum: "pem" "der"

Responses

Response samples

200
400
403
404

Content type

application/json

{"format": "raw",
"encoding": "pem",
"content": "string"
}

Get Certificate Validation Result

path Parameters

uuid

required

string <uuid>

Certificate UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"resultStatus": "not_checked",
"validationChecks": {"property1": {"validationCheck": "certificate_chain",
"status": "not_checked",
"message": "string"
},
"property2": {"validationCheck": "certificate_chain",
"status": "not_checked",
"message": "string"
}
},
"message": "string",
"validationTimestamp": "2019-08-24T14:15:22Z"
}

Get relations for a certificate

path Parameters

uuid

required

string <uuid>

Responses

Get Certificate event history

path Parameters

uuid

required

string <uuid>

Certificate UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "string",
"certificateUuid": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"event": "Issue Certificate",
"status": "SUCCESS",
"message": "string",
"additionalInformation": {"property1": null,
"property2": null
}
}
]

Get certificate chain

Get certificate chain for the certificate with the given UUID. The certificate chain is returned in the order of the chain, with the first certificate being the certificate with the given UUID, up to the last identified certificate in the chain. If the certificate with the given UUID has status NEW or REJECTED, an empty list is returned.

path Parameters

uuid

required

string <uuid>

Certificate UUID

query Parameters

withEndCertificate

boolean

Responses

Response samples

200
400
403
404

Content type

application/json

{"completeChain": true,
"certificates": [{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false,
"extendedKeyUsage": ["string"
],
"keyUsage": ["digitalSignature"
],
"subjectType": "endEntity",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"certificateContent": "string",
"subjectAlternativeNames": {"property1": ["string"
],
"property2": ["string"
]
},
"locations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [null
]
}
],
"pushAttributes": [{"content": [null
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"csrAttributes": [{"content": [null
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [null
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [null
],
"version": "v2"
}
]
}
]
}
],
"nonCompliantRules": [{"connectorName": "Provider1",
"ruleName": "RuleName",
"ruleDescription": "Description sample",
"status": "ok",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"key": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": null,
"data": null
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"keyWrapperUuid": "string",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [ ],
"uuid": null,
"name": null,
"label": null,
"type": null,
"contentType": null,
"version": null
}
]
}
],
"associations": 0,
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"length": 0,
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"complianceStatus": "not_checked"
}
],
"associations": 0,
"complianceStatus": "not_checked"
},
"altKey": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": null,
"data": null
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"keyWrapperUuid": "string",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [ ],
"uuid": null,
"name": null,
"label": null,
"type": null,
"contentType": null,
"version": null
}
]
}
],
"associations": 0,
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"length": 0,
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"complianceStatus": "not_checked"
}
],
"associations": 0,
"complianceStatus": "not_checked"
},
"certificateRequest": {"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"certificateType": "X.509",
"certificateRequestFormat": "pkcs10",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"content": "string",
"commonName": "string",
"subjectDn": "string",
"subjectAlternativeNames": {"property1": ["string"
],
"property2": ["string"
]
},
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"signatureAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"altSignatureAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"keyUuid": "string",
"altKeyUuid": "string",
"complianceStatus": "not_checked"
},
"sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
"issueAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"revokeAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"relatedCertificates": [{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [null
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
}
],
"protocolInfo": {"protocol": "acme",
"protocolProfileUuid": "a286b9c7-97ed-44c6-a837-e8415ab11bf4",
"additionalProtocolUuid": "bcf08956-ad5e-4c4a-863d-293464f7e308"
}
}
]
}

Download Certificate Chain in chosen format

path Parameters

uuid required	string <uuid> Certificate UUID
certificateFormat required	string (CertificateFormat) Enum: "raw" "pkcs7" Certificate format

query Parameters

withEndCertificate	boolean
encoding required	string (CertificateFormatEncoding) Enum: "pem" "der"

Responses

Response samples

200
400
403
404

Content type

application/json

{"format": "raw",
"encoding": "pem",
"content": "string",
"completeChain": true
}

List Certificates Approvals

path Parameters

uuid

required

string <uuid>

Certificate UUID

query Parameters

itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Response samples

200
400
403
404

Content type

application/json

{"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0,
"approvals": [{"approvalUuid": "string",
"creatorUuid": "string",
"creatorUsername": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"expiryAt": "2019-08-24T14:15:22Z",
"closedAt": "2019-08-24T14:15:22Z",
"status": "PENDING",
"resource": "NONE",
"resourceAction": "string",
"objectUuid": "string",
"approvalProfileName": "string",
"approvalProfileUuid": "string"
}
]
}

List of available Locations for the Certificate

path Parameters

certificateUuid

required

string <uuid>

Certificate UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": null,
"name": null
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": null,
"data": null,
"contentType": null
}
],
"version": "v2"
}
]
}
],
"pushAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"csrAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
]
}
]

Get Certificate searchable fields information

Responses

Response samples

200
400
403
404

Content type

application/json

[{"filterFieldSource": "meta",
"searchFieldData": [{"fieldIdentifier": "string",
"fieldLabel": "string",
"type": "string",
"conditions": ["EQUALS"
],
"platformEnum": "Resource",
"attributeContentType": "string",
"value": null,
"multiValue": true
}
]
}
]

Get CSR Generation Attributes

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

SCEP Profile Management

SCEP Profile Management API

Get details of SCEP Profile

path Parameters

uuid

required

string

SCEP Profile UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"description": "Sample description",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"includeCaCertificate": true,
"includeCaCertificateChain": true,
"renewThreshold": 30,
"scepUrl": "https://some-server.com/api/v1/protocols/scep/profile/pkiclient.exe",
"enableIntune": true,
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"caCertificate": {"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
},
"intuneTenant": "string",
"intuneApplicationId": "string",
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
}

Edit SCEP Profile

path Parameters

uuid

required

string

SCEP Profile UUID

Request Body schema: application/json
required

description	string Description of the SCEP Profile
raProfileUuid	string RA Profile UUID
required	Array of objects (RequestAttribute) List of Attributes to issue Certificate
caCertificateUuid required	string UUID of the Certificate to be used as CA Certificate for SCEP Requests
	Array of objects (RequestAttribute) List of Custom Attributes
renewalThreshold	integer <int32> Minimum expiry days to allow renewal of certificate. Empty or the value '0' will be considered as null and half life of the certificate validity will be considered for the protocol. Default value is half of certificate validity.
includeCaCertificate	boolean Default: false Include CA Certificate in the SCEP Message response
includeCaCertificateChain	boolean Default: false Include CA Certificate Chain in the SCEP Message response
challengePassword	string Challenge Password for the SCEP Request
enableIntune	boolean Status of Intune
intuneTenant	string Intune Tenant
intuneApplicationId	string Intune Application ID
intuneApplicationKey	string Intune Application Key
	object (ProtocolCertificateAssociationsRequestDto) Associations to set for certificates issued by the protocol

Responses

Request samples

Payload

Content type

application/json

{"description": "Sample description",
"raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"issueCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"caCertificateUuid": "string",
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"renewalThreshold": 0,
"includeCaCertificate": false,
"includeCaCertificateChain": false,
"challengePassword": "string",
"enableIntune": true,
"intuneTenant": "string",
"intuneApplicationId": "string",
"intuneApplicationKey": "string",
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"description": "Sample description",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"includeCaCertificate": true,
"includeCaCertificateChain": true,
"renewThreshold": 30,
"scepUrl": "https://some-server.com/api/v1/protocols/scep/profile/pkiclient.exe",
"enableIntune": true,
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"caCertificate": {"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
},
"intuneTenant": "string",
"intuneApplicationId": "string",
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
}

Delete SCEP Profile

path Parameters

uuid

required

string

SCEP Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get list of SCEP Profiles

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"description": "Sample description",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"includeCaCertificate": true,
"includeCaCertificateChain": true,
"renewThreshold": 30,
"scepUrl": "https://some-server.com/api/v1/protocols/scep/profile/pkiclient.exe",
"enableIntune": true
}
]

Create SCEP Profile

Request Body schema: application/json
required

description	string Description of the SCEP Profile
raProfileUuid	string RA Profile UUID
required	Array of objects (RequestAttribute) List of Attributes to issue Certificate
caCertificateUuid required	string UUID of the Certificate to be used as CA Certificate for SCEP Requests
	Array of objects (RequestAttribute) List of Custom Attributes
renewalThreshold	integer <int32> Minimum expiry days to allow renewal of certificate. Empty or the value '0' will be considered as null and half life of the certificate validity will be considered for the protocol. Default value is half of certificate validity.
includeCaCertificate	boolean Default: false Include CA Certificate in the SCEP Message response
includeCaCertificateChain	boolean Default: false Include CA Certificate Chain in the SCEP Message response
challengePassword	string Challenge Password for the SCEP Request
enableIntune	boolean Status of Intune
intuneTenant	string Intune Tenant
intuneApplicationId	string Intune Application ID
intuneApplicationKey	string Intune Application Key
	object (ProtocolCertificateAssociationsRequestDto) Associations to set for certificates issued by the protocol
name required	string Name of the SCEP Profile

Responses

Request samples

Payload

Content type

application/json

{"description": "Sample description",
"raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"issueCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"caCertificateUuid": "string",
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"renewalThreshold": 0,
"includeCaCertificate": false,
"includeCaCertificateChain": false,
"challengePassword": "string",
"enableIntune": true,
"intuneTenant": "string",
"intuneApplicationId": "string",
"intuneApplicationKey": "string",
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
},
"name": "Profile Name 1"
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"description": "Sample description",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"includeCaCertificate": true,
"includeCaCertificateChain": true,
"renewThreshold": 30,
"scepUrl": "https://some-server.com/api/v1/protocols/scep/profile/pkiclient.exe",
"enableIntune": true,
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"caCertificate": {"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
},
"intuneTenant": "string",
"intuneApplicationId": "string",
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
}

Update RA Profile for SCEP Profile

path Parameters

uuid required	string SCEP Profile UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable SCEP Profile

path Parameters

uuid

required

string

SCEP Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable SCEP Profile

path Parameters

uuid

required

string

SCEP Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable multiple SCEP Profiles

Request Body schema: application/json
required

SCEP Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Disable multiple SCEP Profile

Request Body schema: application/json
required

SCEP Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Get list of certificates eligible for CA certificate of SCEP requests

query Parameters

intuneEnabled

required

boolean

flag to return certificates that are eligible for Intune integration

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
}
]

Delete multiple SCEP Profiles

Request Body schema: application/json
required

SCEP Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Force delete multiple SCEP Profiles

Request Body schema: application/json
required

SCEP Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
422

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Compliance Profile Management

Compliance Profile Management API

List of available Compliance Profiles

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"rules": [{"connectorName": "string",
"numberOfRules": 0,
"numberOfGroups": 0
}
]
}
]

Add Compliance Profile

Request Body schema: application/json
required

name required	string Name of the Compliance Profile
description	string Description of the Compliance Profile
	Array of objects (ComplianceProfileRulesRequestDto) Rules to be associated with the Compliance Profile. Profiles can be created without rules and can be added later
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "Profile 1",
"description": "Profile 1",
"rules": [{"connectorUuid": "c35bc88c-d0ef-11ec-9d64-0242ac120005",
"kind": "x509",
"rules": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"groups": ["string"
]
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"uuid": "string"
}

Delete multiple Compliance Profiles

Request Body schema: application/json
required

Compliance Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Add rule to a Compliance Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Request Body schema: application/json
required

connectorUuid required	string UUID of the Compliance Provider
kind required	string Kind of the Compliance Provider
ruleUuid required	string UUID of the rule
	Array of objects (RequestAttribute) Attributes for the rule

Responses

Request samples

Payload

Content type

application/json

{"connectorUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"kind": "default",
"ruleUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "Sample rule description",
"connectorName": "string",
"connectorUuid": "string",
"kind": "string",
"groupUuid": "string",
"certificateType": "X.509",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"complianceProfileUuid": "string",
"complianceProfileName": "string"
}

Delete rule from a Compliance Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Request Body schema: application/json
required

connectorUuid required	string UUID of the Compliance Provider
kind required	string Kind of the Compliance Provider
ruleUuid required	string UUID of the rule

Responses

Request samples

Payload

Content type

application/json

{"connectorUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"kind": "default",
"ruleUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9"
}

Response samples

Content type

application/json

{"message": "Error message"
}

Add group to a Compliance Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Request Body schema: application/json
required

connectorUuid required	string UUID of the Compliance Provider
kind required	string Kind of the Compliance Provider
groupUuid required	string UUID of the group

Responses

Request samples

Payload

Content type

application/json

{"connectorUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"kind": "default",
"groupUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9"
}

Response samples

Content type

application/json

{"message": "Error message"
}

Delete group from a Compliance Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Request Body schema: application/json
required

connectorUuid required	string UUID of the Compliance Provider
kind required	string Kind of the Compliance Provider
groupUuid required	string UUID of the group

Responses

Request samples

Payload

Content type

application/json

{"connectorUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
"kind": "default",
"groupUuid": "20354d7a-e4fe-47af-8ff6-187bca92f3f9"
}

Response samples

Content type

application/json

{"message": "Error message"
}

Initiate Certificate Compliance Check

Request Body schema: application/json
required

RA Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Disassociate Compliance Profile to RA Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Request Body schema: application/json
required

raProfileUuids

required

Array of strings

List of UUIDs of RA Profiles to be associated

Responses

Request samples

Payload

Content type

application/json

{"raProfileUuids": ["18324af0-e95c-11ec-8fea-0242ac120002",
"18324c94-e95c-11ec-8fea-0242ac120002"
]
}

Response samples

Content type

application/json

{"message": "Error message"
}

Associate Compliance Profile to RA Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Request Body schema: application/json
required

raProfileUuids

required

Array of strings

List of UUIDs of RA Profiles to be associated

Responses

Request samples

Payload

Content type

application/json

{"raProfileUuids": ["18324af0-e95c-11ec-8fea-0242ac120002",
"18324c94-e95c-11ec-8fea-0242ac120002"
]
}

Response samples

Content type

application/json

{"message": "Error message"
}

Details of a Compliance Profiles

path Parameters

uuid

required

string

Compliance Profile UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"rules": [{"connectorName": "string",
"connectorUuid": "string",
"kind": "string",
"rules": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "Sample rule description",
"certificateType": "X.509",
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
]
}
],
"groups": [{"connectorName": "string",
"connectorUuid": "string",
"kind": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "Sample group description"
}
]
}
],
"raProfiles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Delete Compliance Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Get RA Profiles for a Compliance Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
}
]

Get Compliance rules

query Parameters

complianceProvider	string
kind	string
certificateType	Array of strings (CertificateType) Items Enum: "X.509" "SSH"

Responses

Response samples

Content type

application/json

[{"connectorName": "Provider1",
"connectorUuid": "c35bc88c-d0ef-11ec-9d64-0242ac120003",
"kind": "Kind1",
"rules": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"groupUuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Rule1",
"certificateType": "X.509",
"attributes": [{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": [null
],
"value": null
}
]
}
}
],
"description": "Sample rule description"
}
]
}
]

Get Compliance groups

query Parameters

complianceProvider	string
kind	string

Responses

Response samples

Content type

application/json

[{"connectorName": "Provider1",
"connectorUuid": "c35bc88c-d0ef-11ec-9d64-0242ac120003",
"kind": "Kind1",
"groups": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "RFC",
"description": "Sample description of the group"
}
]
}
]

Force delete Compliance Profiles

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Token Instance Management

Token Instance Management API

Get Token Instance Detail

path Parameters

uuid

required

string

UUID of the Token Instance

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"connectorName": "string",
"connectorUuid": "string",
"kind": "string",
"status": {"status": "Connected",
"components": {"property1": {"status": "Connected",
"details": {"property1": null,
"property2": null
}
},
"property2": {"status": "Connected",
"details": {"property1": null,
"property2": null
}
}
}
},
"tokenProfiles": 0,
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Update Token Instance

path Parameters

uuid

required

string

Token Instance UUID

Request Body schema: application/json
required

name required	string Name of the Token Instance
description	string Token Instance description
connectorUuid required	string UUID of the Connector
kind required	string Connector Kind
required	Array of objects (RequestAttribute) Custom Attributes
required	Array of objects (RequestAttribute) Attributes for Token Instance

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"connectorUuid": "string",
"kind": "string",
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"connectorName": "string",
"connectorUuid": "string",
"kind": "string",
"status": {"status": "Connected",
"components": {"property1": {"status": "Connected",
"details": {"property1": null,
"property2": null
}
},
"property2": {"status": "Connected",
"details": {"property1": null,
"property2": null
}
}
}
},
"tokenProfiles": 0,
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Delete Token Instance

path Parameters

uuid

required

string

Token Instance UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Reload Token Instance status

path Parameters

uuid

required

string

UUID of the Token Instance

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"connectorName": "string",
"connectorUuid": "string",
"kind": "string",
"status": {"status": "Connected",
"components": {"property1": {"status": "Connected",
"details": {"property1": null,
"property2": null
}
},
"property2": {"status": "Connected",
"details": {"property1": null,
"property2": null
}
}
}
},
"tokenProfiles": 0,
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

List Token Instances

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"status": "Connected",
"tokenProfiles": 0,
"connectorName": "string",
"connectorUuid": "string",
"kind": "string"
}
]

Create a new Token Instance

Request Body schema: application/json
required

name required	string Name of the Token Instance
description	string Token Instance description
connectorUuid required	string UUID of the Connector
kind required	string Connector Kind
required	Array of objects (RequestAttribute) Custom Attributes
required	Array of objects (RequestAttribute) Attributes for Token Instance

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"connectorUuid": "string",
"kind": "string",
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

201
400
403
404
422

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"connectorName": "string",
"connectorUuid": "string",
"kind": "string",
"status": {"status": "Connected",
"components": {"property1": {"status": "Connected",
"details": {"property1": null,
"property2": null
}
},
"property2": {"status": "Connected",
"details": {"property1": null,
"property2": null
}
}
}
},
"tokenProfiles": 0,
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Deactivate Token Instance

path Parameters

uuid

required

string

Token Instance UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Activate Token Instance

path Parameters

uuid

required

string

Token Instance UUID

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List Token Profile Attributes

path Parameters

uuid

required

string

Token instance UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

List Token activation Attributes

path Parameters

uuid

required

string

Token Instance UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Delete multiple Token Instances

Request Body schema: application/json
required

Token Instance UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Cryptographic Operations Controller

Cryptographic Operations Controller API

Verify data using a Key

path Parameters

tokenInstanceUuid required	string Token Instance UUID
tokenProfileUuid required	string Token Profile UUID
uuid required	string Key UUID
keyItemUuid required	string Key Item UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) List of signature Attributes
required	Array of objects (SignatureRequestData) Data to be signed
required	Array of objects (SignatureRequestData) Signatures to verify

Responses

Request samples

Payload

Content type

application/json

{"signatureAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"data": [{"data": "string",
"identifier": "customId"
}
],
"signatures": [{"data": "string",
"identifier": "customId"
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

{"verifications": [{"result": true,
"identifier": "customId",
"details": null
}
]
}

Sign data using a Key

path Parameters

tokenInstanceUuid required	string Token Instance UUID
tokenProfileUuid required	string Token Profile UUID
uuid required	string Key UUID
keyItemUuid required	string Key Item UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) List of signature Attributes
required	Array of objects (SignatureRequestData) Data to be signed

Responses

Request samples

Payload

Content type

application/json

{"signatureAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"data": [{"data": "string",
"identifier": "customId"
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

{"signatures": [{"data": "string",
"identifier": "customId",
"details": null
}
]
}

Encrypt data using a Key

path Parameters

tokenInstanceUuid required	string Token Instance UUID
tokenProfileUuid required	string Token Profile UUID
uuid required	string Key UUID
keyItemUuid required	string Key Item UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) List of cipher Attributes
required	Array of objects (CipherRequestData) Encrypted/decrypted data

Responses

Request samples

Payload

Content type

application/json

{"cipherAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"cipherData": [{"data": "string",
"identifier": "customId"
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

{"encryptedData": [{"data": "string",
"identifier": "customId",
"details": null
}
]
}

Decrypt data using a Key

path Parameters

tokenInstanceUuid required	string Token Instance UUID
tokenProfileUuid required	string Token Profile UUID
uuid required	string Key UUID
keyItemUuid required	string Key Item UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) List of cipher Attributes
required	Array of objects (CipherRequestData) Encrypted/decrypted data

Responses

Request samples

Payload

Content type

application/json

{"cipherAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"cipherData": [{"data": "string",
"identifier": "customId"
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

{"decryptedData": [{"data": "string",
"identifier": "customId",
"details": null
}
]
}

Generate random data

path Parameters

tokenInstanceUuid

required

string

Token Instance UUID

Request Body schema: application/json
required

length required	integer <int32> Number of random bytes to generate
	Array of objects (RequestAttribute) Random generator Attributes

Responses

Request samples

Payload

Content type

application/json

{"length": 0,
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

{"data": "string"
}

List of signature Attributes

path Parameters

tokenInstanceUuid required	string Token Instance UUID
tokenProfileUuid required	string Token Profile UUID
uuid required	string Key instance UUID
keyItemUuid required	string Key Item UUID
algorithm required	string (KeyAlgorithm) Enum: "RSA" "ECDSA" "FALCON" "ML-DSA" "SLH-DSA" "ML-KEM" "CRYSTALS-Dilithium" "SPHINCS+" "Unknown" Cryptographic algorithm

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

List of cipher Attributes

path Parameters

tokenInstanceUuid required	string Token Instance UUID
tokenProfileUuid required	string Token Profile UUID
uuid required	string Key UUID
keyItemUuid required	string Key Item UUID
algorithm required	string (KeyAlgorithm) Enum: "RSA" "ECDSA" "FALCON" "ML-DSA" "SLH-DSA" "ML-KEM" "CRYSTALS-Dilithium" "SPHINCS+" "Unknown" Cryptographic algorithm

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

List of random generator Attributes

path Parameters

tokenInstanceUuid

required

string

Token Instance UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Custom OID Management

Custom OID Management API

Get custom OID entry by OID

path Parameters

oid

required

string

OID identifier

Responses

Response samples

200
400
403

Content type

application/json

{"oid": "string",
"displayName": "string",
"description": "string",
"category": "rdnAttributeType",
"additionalProperties": {"code": "string",
"altCodes": ["string"
]
}
}

Edit an existing custom OID entry

path Parameters

oid

required

string

OID identifier

Request Body schema: application/json
required

displayName required	string non-empty Display name of the custom OID entry
description	string Description of the custom OID entry
category required	string (OidCategory) Enum: "rdnAttributeType" "extendedKeyUsage" "generic" Category of the OID entry. When updating OID entry, this property does not change the category and is instead used to determine type of additional properties.
	RdnAttributeTypeOidPropertiesDto (object) Additional properties depending on OID category

Responses

Request samples

Payload

Content type

application/json

{"displayName": "string",
"description": "string",
"category": "rdnAttributeType",
"additionalProperties": {"code": "string",
"altCodes": ["string"
]
}
}

Response samples

200
400
403

Content type

application/json

{"oid": "string",
"displayName": "string",
"description": "string",
"category": "rdnAttributeType",
"additionalProperties": {"code": "string",
"altCodes": ["string"
]
}
}

Delete a custom OID entry by OID

path Parameters

oid

required

string

OID identifier

Responses

Create a new custom OID entry

Request Body schema: application/json
required

displayName required	string non-empty Display name of the custom OID entry
description	string Description of the custom OID entry
category required	string (OidCategory) Enum: "rdnAttributeType" "extendedKeyUsage" "generic" Category of the OID entry. When updating OID entry, this property does not change the category and is instead used to determine type of additional properties.
	RdnAttributeTypeOidPropertiesDto (object) Additional properties depending on OID category
oid required	string non-empty ^[0-2](\.(0\|[1-9]\d*)){1,50}$ Object Identifier (OID) in dot notation (e.g., 1.2.840.113549.1.1.1)

Responses

Request samples

Payload

Content type

application/json

{"displayName": "string",
"description": "string",
"category": "rdnAttributeType",
"additionalProperties": {"code": "string",
"altCodes": ["string"
]
},
"oid": "1.2.840.113549.1.1.1"
}

Response samples

200
400
403

Content type

application/json

{"oid": "string",
"displayName": "string",
"description": "string",
"category": "rdnAttributeType",
"additionalProperties": {"code": "string",
"altCodes": ["string"
]
}
}

Bulk delete customOID entries

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

List custom OID entries with filtering and pagination

Request Body schema: application/json
required

	Array of objects (SearchFilterRequestDto) Certificate filter input
itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": null
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

200
400
403

Content type

application/json

{"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0,
"oidEntries": [{"oid": "string",
"displayName": "string",
"description": "string",
"category": "rdnAttributeType"
}
]
}

Get searchable filter fields for custom OID entries

Responses

Response samples

200
400
403

Content type

application/json

[{"filterFieldSource": "meta",
"searchFieldData": [{"fieldIdentifier": "string",
"fieldLabel": "string",
"type": "string",
"conditions": ["EQUALS"
],
"platformEnum": "Resource",
"attributeContentType": "string",
"value": null,
"multiValue": true
}
]
}
]

Workflow Rules Management

Workflow Rules Management API

Get Rule details

path Parameters

ruleUuid

required

string

Rule UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"conditions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]
}

Update Rule

path Parameters

ruleUuid

required

string

Rule UUID

Request Body schema: application/json
required

description	string Description of the Rule
conditionsUuids required	Array of strings List of UUIDs of existing conditions to add to the rule

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"conditionsUuids": ["string"
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"conditions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]
}

Delete Rule

path Parameters

ruleUuid

required

string

Rule UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Condition details

path Parameters

conditionUuid

required

string

Condition UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}

Update Condition

path Parameters

conditionUuid

required

string

Condition UUID

Request Body schema: application/json
required

description	string Description of the condition
required	Array of objects (ConditionItemRequestDto) List of the condition items to add to condition

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}

Delete Condition

path Parameters

conditionUuid

required

string

Condition UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List Rules

query Parameters

resource

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE"
}
]

Create Rule

Request Body schema: application/json
required

name required	string Name of the rule
description	string Description of the rule
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the rule
conditionsUuids required	Array of strings List of UUIDs of existing conditions to add to the rule

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"resource": "NONE",
"conditionsUuids": ["string"
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"resource": "NONE",
"conditions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]
}

List Conditions

query Parameters

resource

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}
]

Create Condition

Request Body schema: application/json
required

name required	string Name of the condition
description	string Description of the condition
type required	string (ConditionType) Value: "checkField" Type of the condition
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the condition
required	Array of objects (ConditionItemRequestDto) List of the condition items to add to condition

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}

Response samples

201
400
403

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"type": "checkField",
"resource": "NONE",
"items": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": null
}
]
}

Info

CZERTAINLY Application Information API

Get information about running CZERTAINLY Application

Responses

Response samples

200
400
403

Content type

application/json

{"app": {"name": "string",
"version": "string"
},
"build": {"timestamp": "2024-06-01T12:00:00Z",
"branch": "main",
"commitId": "a1b2c3d"
},
"db": {"system": "string",
"version": "string"
}
}

Health readiness check endpoint

Responses

Response samples

200
400

Content type

application/json

{"status": "UNKNOWN"
}

Health liveness check endpoint

Responses

Response samples

200
400

Content type

application/json

{"status": "UNKNOWN"
}

Enums

Enums API

Get platform enums

Responses

Response samples

200
400
403

Content type

application/json

{"property1": {"property1": {"code": "X509",
"label": "X.509",
"description": "X.509 Certificate type"
},
"property2": {"code": "X509",
"label": "X.509",
"description": "X.509 Certificate type"
}
},
"property2": {"property1": {"code": "X509",
"label": "X.509",
"description": "X.509 Certificate type"
},
"property2": {"code": "X509",
"label": "X.509",
"description": "X.509 Certificate type"
}
}
}

Connector Authentication

Connector Authentication API

Validate JWT auth Attributes

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Validate certificate auth Attributes

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Validate basic auth Attributes

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Validate API Key Attributes

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get list of Authentication Types

Responses

Response samples

200
400
403
404

Content type

application/json

["string"
]

Get JWT auth Attributes

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Get Attributes for certificate auth

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Get basic auth Attributes

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Get API Key auth Attributes

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Cryptographic Key Management

Cryptographic Key Management API

Update Key Usage with Token Instance Deprecated

If the request body provided, only those key items will be updated. If the request body is not provided or given empty, then the entire key will be updated

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Key UUID

Request Body schema: application/json
required

usage required	Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key
uuids	Array of strings <uuid> [ items <uuid > ] List of UUIDs of the key Items. If not provided, the usage will be updated to all the itemsin the key

Responses

Request samples

Payload

Content type

application/json

{"usage": ["sign"
],
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Cryptographic Key Detail

path Parameters

uuid

required

string

UUID of the Key

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"keyData": "string",
"length": 0,
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"reason": "disclosure",
"complianceStatus": "not_checked"
}
],
"associations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"resource": "NONE"
}
],
"complianceStatus": "not_checked"
}

Edit Key

path Parameters

uuid

required

string

Key UUID

Request Body schema: application/json
required

tokenProfileUuid	string UUID of the token profile
name required	string Name of the Cryptographic Key
description required	string Description of the Cryptographic Key
ownerUuid	string Key Owner UUID
groupUuids	Array of strings UUIDs of the groups to associate with key
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"tokenProfileUuid": "string",
"name": "string",
"description": "string",
"ownerUuid": "string",
"groupUuids": ["string"
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"keyData": "string",
"length": 0,
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"reason": "disclosure",
"complianceStatus": "not_checked"
}
],
"associations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"resource": "NONE"
}
],
"complianceStatus": "not_checked"
}

Delete Cryptographic Key

If the request body provided, only those key items will be deleted. If the request body is not provided or given empty, then the entire key will be destroyed

path Parameters

uuid

required

string

Key UUID

Request Body schema: application/json

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Update Key Usage

If the request body provided, only those key items will be updated. If the request body is not provided or given empty, then the entire key will be updated

path Parameters

uuid

required

string

Key UUID

Request Body schema: application/json
required

usage required	Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key
uuids	Array of strings <uuid> [ items <uuid > ] List of UUIDs of the key Items. If not provided, the usage will be updated to all the itemsin the key

Responses

Request samples

Payload

Content type

application/json

{"usage": ["sign"
],
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Update Key Usages for Multiple Keys

Update the key usages for multiple keys and all the items inside it

Request Body schema: application/json
required

usage required	Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key
uuids required	Array of strings <uuid> [ items <uuid > ] Key UUIDs

Responses

Request samples

Payload

Content type

application/json

{"usage": ["sign"
],
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Update Key Usages for Multiple Key Items

Update the key usages for multiple keys Items

Request Body schema: application/json
required

usage required	Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key
uuids required	Array of strings <uuid> [ items <uuid > ] Key Item UUIDs

Responses

Request samples

Payload

Content type

application/json

{"usage": ["sign"
],
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Create a new Cryptographic Key

path Parameters

tokenInstanceUuid required	string UUID of the Token Instance
tokenProfileUuid required	string UUID of the Token Profile
type required	string (KeyRequestType) Enum: "secret" "keyPair" Type of the key to be created

Request Body schema: application/json
required

name required	string Name of the Cryptographic Key
description required	string Description of the Cryptographic Key
groupUuids	Array of strings UUIDs of the groups to associate with key
required	Array of objects (RequestAttribute) List of Attributes to create a Key
	Array of objects (RequestAttribute) Custom Attributes for the key
enabled	boolean Default: false Enabled status of created key. True = Enabled, False = Disabled

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"groupUuids": ["string"
],
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"enabled": false
}

Response samples

201
400
403
404
422

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"keyData": "string",
"length": 0,
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"reason": "disclosure",
"complianceStatus": "not_checked"
}
],
"associations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"resource": "NONE"
}
],
"complianceStatus": "not_checked"
}

List cryptographic keys

Request Body schema: application/json
required

	Array of objects (SearchFilterRequestDto) Certificate filter input
itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": null
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

200
400
403

Content type

application/json

{"cryptographicKeys": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"keyWrapperUuid": "string",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"associations": 0,
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"length": 0,
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"complianceStatus": "not_checked"
}
],
"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0
}

Delete Multiple Cryptographic Key

Request Body schema: application/json
required

Key UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Sync Keys from connector

path Parameters

tokenInstanceUuid

required

string

Token Instance UUID

Responses

Enable Key with Token Instance Deprecated

If the request body provided, only those key items will be enabled. If the request body is not provided or given empty, then the entire key will be enabled

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Key UUID

Request Body schema: application/json

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable Key with Token Instance Deprecated

If the request body provided, only those key items will be disabled. If the request body is not provided or given empty, then the entire key will be disabled

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Key UUID

Request Body schema: application/json

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Destroy Cryptographic Key with Token Instance Deprecated

If the request body provided, only those key items will be destroyed. If the request body is not provided or given empty, then the entire key will be destroyed

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Key UUID

Request Body schema: application/json

Key UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Mark Key and its Items as Compromised with Token Instance Deprecated

If the request body is provided with the UUID of the items of Key, then only those itemswill be compromised. Else all the sub items of the key will be compromised

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Key UUID

Request Body schema: application/json
required

reason required	string (KeyCompromiseReason) Enum: "disclosure" "modification" "substitution" "use_of_sensitive_data" Usages for the Key
uuids	Array of strings <uuid> [ items <uuid > ] List of UUIDs of the key Items. If not provided, the usage will be updated to all the itemsin the key

Responses

Request samples

Payload

Content type

application/json

{"reason": "disclosure",
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Cryptographic Key Detail

path Parameters

uuid required	string UUID of the Key
keyItemUuid required	string UUID of the Key Item

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"keyData": "string",
"length": 0,
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"reason": "disclosure",
"complianceStatus": "not_checked"
}

Edit Key Item

path Parameters

uuid required	string Key UUID
keyItemUuid required	string Key Item UUID

Request Body schema: application/json
required

name

required

string

Name of the key item

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

422

Content type

*/*

[
  "Error Message 1",
  "Error Message 2"
]

Enable Key

If the request body provided, only those key items will be enabled. If the request body is not provided or given empty, then the entire key will be enabled

path Parameters

uuid

required

string

Key UUID

Request Body schema: application/json

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable Key

If the request body provided, only those key items will be disabled. If the request body is not provided or given empty, then the entire key will be disabled

path Parameters

uuid

required

string

Key UUID

Request Body schema: application/json

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Destroy Cryptographic Key

If the request body provided, only those key items will be destroyed. If the request body is not provided or given empty, then the entire key will be destroyed

path Parameters

uuid

required

string

Key UUID

Request Body schema: application/json

Key UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Mark Key and its Items as Compromised

If the request body is provided with the UUID of the items of Key, then only those itemswill be compromised. Else all the sub items of the key will be compromised

path Parameters

uuid

required

string

Key UUID

Request Body schema: application/json
required

reason required	string (KeyCompromiseReason) Enum: "disclosure" "modification" "substitution" "use_of_sensitive_data" Usages for the Key
uuids	Array of strings <uuid> [ items <uuid > ] List of UUIDs of the key Items. If not provided, the usage will be updated to all the itemsin the key

Responses

Request samples

Payload

Content type

application/json

{"reason": "disclosure",
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable multiple Key Items

Request Body schema: application/json
required

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Disable multiple Key Items

Request Body schema: application/json
required

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Destroy Multiple Cryptographic Key items

Request Body schema: application/json
required

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Mark Multiple Key Items as Compromised

This API can be used to mark multiple keys items to be marked as compromised.

Request Body schema: application/json
required

reason required	string (KeyCompromiseReason) Enum: "disclosure" "modification" "substitution" "use_of_sensitive_data" Usages for the Key
uuids	Array of strings <uuid> [ items <uuid > ] List of Key Item UUID

Responses

Request samples

Payload

Content type

application/json

{"reason": "disclosure",
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Enable multiple Keys

Request Body schema: application/json
required

Key UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Disable multiple Keys

Request Body schema: application/json
required

Key UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Destroy Multiple Cryptographic Key and its items

Request Body schema: application/json
required

Key UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Mark Multiple Key and all its Items as Compromised

This API can be used to mark multiple keys and its sub items to be marked as compromised.Specific part of the key cannot be mentioned in this API

Request Body schema: application/json
required

reason required	string (KeyCompromiseReason) Enum: "disclosure" "modification" "substitution" "use_of_sensitive_data" Usages for the Key
uuids	Array of strings <uuid> [ items <uuid > ] List of UUIDs of the keys. This will mark all the items inside the selected key as compromised

Responses

Request samples

Payload

Content type

application/json

{"reason": "disclosure",
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

List of Attributes to create a Key

path Parameters

tokenInstanceUuid required	string Token Instance UUID
tokenProfileUuid required	string Token Profile UUID
type required	string (KeyRequestType) Enum: "secret" "keyPair" Type of the key to be created

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Get Cryptographic Key Detail with Token Instance Deprecated

path Parameters

tokenInstanceUuid required	string UUID of the Token Instance
uuid required	string UUID of the Key

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"keyData": "string",
"length": 0,
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"reason": "disclosure",
"complianceStatus": "not_checked"
}
],
"associations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"resource": "NONE"
}
],
"complianceStatus": "not_checked"
}

Delete Cryptographic Key with Token Instance Deprecated

If the request body provided, only those key items will be deleted. If the request body is not provided or given empty, then the entire key will be destroyed

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Key UUID

Request Body schema: application/json

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Cryptographic Key Detail with Token Instance Deprecated

path Parameters

tokenInstanceUuid required	string UUID of the Token Instance
uuid required	string UUID of the Key
keyItemUuid required	string UUID of the Key Item

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"keyData": "string",
"length": 0,
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"reason": "disclosure",
"complianceStatus": "not_checked"
}

Get Key Item event history with Token Instance Deprecated

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Key UUID
keyItemUuid required	string Key Item UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "string",
"keyUuid": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"event": "Create Key",
"status": "SUCCESS",
"message": "string",
"additionalInformation": {"property1": null,
"property2": null
}
}
]

Get Key Item event history

path Parameters

uuid required	string Key UUID
keyItemUuid required	string Key Item UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "string",
"keyUuid": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"event": "Create Key",
"status": "SUCCESS",
"message": "string",
"additionalInformation": {"property1": null,
"property2": null
}
}
]

Get CryptographicKey searchable fields information

Responses

Response samples

200
400
403

Content type

application/json

[{"filterFieldSource": "meta",
"searchFieldData": [{"fieldIdentifier": "string",
"fieldLabel": "string",
"type": "string",
"conditions": ["EQUALS"
],
"platformEnum": "Resource",
"attributeContentType": "string",
"value": null,
"multiValue": true
}
]
}
]

List Cryptographic Keys with full Key Pairs

This API contains the logic to get the keys that contains the full key pair (private and public Key)

query Parameters

tokenProfileUuid

string

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"keyWrapperUuid": "string",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": null,
"data": null
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"associations": 0,
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"length": 0,
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"complianceStatus": "not_checked"
}
],
"associations": 0,
"complianceStatus": "not_checked"
}
]

Delete Multiple Cryptographic Key Items

Request Body schema: application/json
required

Key Items UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Resource Management

Resource Management API

Retrieve list of resources with information and settings

Responses

Response samples

200
400
403

Content type

application/json

[{"resource": "NONE",
"hasObjectAccess": true,
"hasCustomAttributes": true,
"hasGroups": true,
"hasOwner": true,
"hasEvents": true,
"hasRuleEvaluator": true,
"complianceSubject": true,
"hasComplianceProfiles": true
}
]

Retrieve filter fields that can be used for creating rule conditions and actions

path Parameters

resource

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Resource

query Parameters

settable

boolean

Responses

Response samples

200
400
403
404

Content type

application/json

[{"filterFieldSource": "meta",
"searchFieldData": [{"fieldIdentifier": "string",
"fieldLabel": "string",
"type": "string",
"conditions": ["EQUALS"
],
"platformEnum": "Resource",
"attributeContentType": "string",
"value": null,
"multiValue": true
}
]
}
]

Retrieve a list of all events that can be triggered by a resource

path Parameters

resource

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Resource

Responses

Response samples

200
400
403

Content type

application/json

[{"event": "certificate_status_changed",
"producedResource": "NONE"
}
]

Retrieve a list of all events that can be triggered by all resources

This endpoint returns a map of resource events, where the key is the event type and the value is a list of event details.

Responses

Response samples

200
400
403

Content type

application/json

{"property1": [{"event": "certificate_status_changed",
"producedResource": "NONE"
}
],
"property2": [{"event": "certificate_status_changed",
"producedResource": "NONE"
}
]
}

Notification profile inventory

Notification profile inventory API

Get Notification profile details

path Parameters

uuid

required

string

Notification profile UUID

query Parameters

version

required

integer <int32>

Select specific version of the notification profile

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"name": "NotificationProfile1",
"description": "Detail description of the notification profile",
"version": 1,
"recipientType": "none",
"recipients": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"notificationInstance": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
},
"internalNotification": true,
"frequency": "P1DT12H",
"repetitions": 0
}

Edit Notification profile

path Parameters

uuid

required

string

Notification profile UUID

Request Body schema: application/json
required

description	string Description of the Notification profile
recipientType required	string (RecipientType) Enum: "none" "default" "user" "group" "role" "owner" Recipient type of notifications produced by profile
recipientUuids	Array of strings <uuid> [ items <uuid > ] Recipient UUIDs of notifications produced by profile
notificationInstanceUuid	string <uuid> Notification instance UUID
internalNotification required	boolean Is notification profile sending internal notifications
frequency	string <duration> Frequency of repeated notification
repetitions	integer <int32> Maximum number of repetitions of same notification

Responses

Request samples

Payload

Content type

application/json

{"description": "Detail description of the notification profile",
"recipientType": "none",
"recipientUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"notificationInstanceUuid": "250850b8-eed4-41a2-9559-3e2c4e8a5661",
"internalNotification": true,
"frequency": "P1DT12H",
"repetitions": 0
}

Response samples

200
400
403
404
422

Content type

application/json

{"uuid": "string",
"name": "NotificationProfile1",
"description": "Detail description of the notification profile",
"version": 1,
"recipientType": "none",
"recipients": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"notificationInstance": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
},
"internalNotification": true,
"frequency": "P1DT12H",
"repetitions": 0
}

Delete notification profile

path Parameters

uuid

required

string

Notification profile UUID

Responses

Response samples

400
403
404
422

Content type

application/json

{"message": "Error message"
}

List Notification profiles

query Parameters

itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Response samples

200
400
403

Content type

application/json

{"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0,
"notificationProfiles": [{"uuid": "string",
"name": "NotificationProfile1",
"description": "Detail description of the notification profile",
"version": 1,
"recipientType": "none",
"recipientUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"notificationInstanceUuid": "250850b8-eed4-41a2-9559-3e2c4e8a5661",
"internalNotification": true
}
]
}

Create Notification profile

Request Body schema: application/json
required

description	string Description of the Notification profile
recipientType required	string (RecipientType) Enum: "none" "default" "user" "group" "role" "owner" Recipient type of notifications produced by profile
recipientUuids	Array of strings <uuid> [ items <uuid > ] Recipient UUIDs of notifications produced by profile
notificationInstanceUuid	string <uuid> Notification instance UUID
internalNotification required	boolean Is notification profile sending internal notifications
frequency	string <duration> Frequency of repeated notification
repetitions	integer <int32> Maximum number of repetitions of same notification
name required	string non-empty Name of the Notification profile

Responses

Request samples

Payload

Content type

application/json

{"description": "Detail description of the notification profile",
"recipientType": "none",
"recipientUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"notificationInstanceUuid": "250850b8-eed4-41a2-9559-3e2c4e8a5661",
"internalNotification": true,
"frequency": "P1DT12H",
"repetitions": 0,
"name": "NotificationProfile1"
}

Response samples

200
400
403
404
422

Content type

application/json

{"uuid": "string",
"name": "NotificationProfile1",
"description": "Detail description of the notification profile",
"version": 1,
"recipientType": "none",
"recipients": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"notificationInstance": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
},
"internalNotification": true,
"frequency": "P1DT12H",
"repetitions": 0
}

Connector Registration

Connector Registration API

Register a Connector v2

Request Body schema: application/json
required

name required	string non-empty Name of the Connector
version required	string (ConnectorVersion) Enum: "v1" "v2" Version of the Connector.
url required	string URL of the Connector to connect
authType required	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttribute) List of authentication Attributes. Required if the authentication type is not NONE
required	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "Connector1",
"version": "v1",
"url": "http://network-discovery-provider:8080",
"authType": "none",
"authAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"version": "v1",
"url": "http://network-discovery-provider:8080",
"status": "waitingForApproval",
"functionGroups": [{"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
],
"interfaces": [{"code": "info",
"version": "string",
"features": ["stateless"
]
}
],
"authType": "none",
"authAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Register a Connector

Request Body schema: application/json
required

name required	string Name of the Connector
url required	string URL of the Connector to connect
authType required	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttribute) List of authentication Attributes. Required if the authentication type is not NONE
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "Connector1",
"url": "http://network-discovery-provider:8080",
"authType": "none",
"authAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
404

Content type

application/json

{"uuid": "string"
}

Group management

Group management API

Group details

path Parameters

uuid

required

string

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Edit Group

path Parameters

uuid

required

string

Group UUID

Request Body schema: application/json
required

name required	string Name of the Group
description	string Description of the Group
email	string Group contact email
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Delete Group

path Parameters

uuid

required

string

Group UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List Groups

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
]

Create Group

Request Body schema: application/json
required

name required	string Name of the Group
description	string Description of the Group
email	string Group contact email
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "string"
}

Delete multiple Groups

Request Body schema: application/json
required

Group UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Role Management

Role Management API

Get role details

path Parameters

roleUuid

required

string

Role UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true,
"users": [{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Update Role

path Parameters

roleUuid

required

string

Role UUID

Request Body schema: application/json
required

name	string Name of the role
description	string Description for the role
email	string Role contact email
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true,
"users": [{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Delete Role

path Parameters

roleUuid

required

string

Role UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Update Resource Objects to a Role

path Parameters

roleUuid required	string Role UUID
resourceUuid required	string Resource UUID
objectUuid required	string Object UUID

Request Body schema: application/json
required

uuid required	string UUID of the Object
name required	string Name of the Object
allow	Array of strings Allowed Action list
deny	Array of strings Denied Action list

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Update Resource Objects to a Role

path Parameters

roleUuid required	string Role UUID
resourceUuid required	string Resource UUID
objectUuid required	string Object UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List Roles

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
]

Create Role

Request Body schema: application/json
required

name	string Name of the role
description	string Description for the role
email	string Role contact email
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

201
400
403

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true,
"users": [{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Get Permissions of a Role

path Parameters

roleUuid

required

string

Role UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"allowAllResources": true,
"resources": [{"name": "string",
"allowAllActions": true,
"actions": ["string"
],
"objects": [{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]
}
]
}

Add permissions to Role

path Parameters

roleUuid

required

string

Role UUID

Request Body schema: application/json
required

allowAllResources required	boolean Allow all resources, True = Yes, False = No
	Array of objects (ResourcePermissionsRequestDto) Resources

Responses

Request samples

Payload

Content type

application/json

{"allowAllResources": true,
"resources": [{"name": "string",
"allowAllActions": true,
"actions": ["string"
],
"objects": [{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"allowAllResources": true,
"resources": [{"name": "string",
"allowAllActions": true,
"actions": ["string"
],
"objects": [{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]
}
]
}

Get Resource Objects of a Role

path Parameters

roleUuid required	string Role UUID
resourceUuid required	string Resource UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]

Add Resource Objects to a Role

path Parameters

roleUuid required	string Role UUID
resourceUuid required	string Resource UUID

Request Body schema: application/json
required

Array

uuid required	string UUID of the Object
name required	string Name of the Object
allow	Array of strings Allowed Action list
deny	Array of strings Denied Action list

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Role Users

path Parameters

roleUuid

required

string

Role UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true
}
]

Add users to Role

path Parameters

roleUuid

required

string

Role UUID

Request Body schema: application/json
required

User UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true,
"users": [{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}

Get Resources of a Role

path Parameters

roleUuid required	string Role UUID
resourceUuid required	string Resource UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"name": "string",
"allowAllActions": true,
"actions": ["string"
],
"objects": [{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]
}

Approval Inventory

Approval Inventory API

Rejecting of the Approval

path Parameters

uuid

required

string

Approval UUID

Responses

Rejecting of Recipient of the Approval

path Parameters

uuid

required

string

Approval UUID

Request Body schema: application/json
required

comment

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

Approving of the Approval

path Parameters

uuid

required

string

Approval UUID

Responses

Approving of Recipient of the Approval

path Parameters

uuid

required

string

Approval UUID

Request Body schema: application/json
required

comment

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

List of Approvals

query Parameters

itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Response samples

200
400
403

Content type

application/json

{"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0,
"approvals": [{"approvalUuid": "string",
"creatorUuid": "string",
"creatorUsername": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"expiryAt": "2019-08-24T14:15:22Z",
"closedAt": "2019-08-24T14:15:22Z",
"status": "PENDING",
"resource": "NONE",
"resourceAction": "string",
"objectUuid": "string",
"approvalProfileName": "string",
"approvalProfileUuid": "string"
}
]
}

Get Approval Detail

path Parameters

uuid

required

string

Approval UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"approvalUuid": "string",
"creatorUuid": "string",
"creatorUsername": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"expiryAt": "2019-08-24T14:15:22Z",
"closedAt": "2019-08-24T14:15:22Z",
"status": "PENDING",
"resource": "NONE",
"resourceAction": "string",
"objectUuid": "string",
"approvalProfileName": "string",
"approvalProfileUuid": "string",
"expiry": 0,
"description": "string",
"approvalSteps": [{"userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
"roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
"groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
"description": "string",
"order": 0,
"requiredApprovals": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"username": "string",
"roleName": "string",
"groupName": "string",
"approvalStepRecipients": [{"approvalRecipientUuid": "string",
"userUuid": "string",
"username": "string",
"createdAt": "2019-08-24T14:15:22Z",
"closedAt": "2019-08-24T14:15:22Z",
"status": "PENDING",
"comment": "string"
}
]
}
]
}

List of User's Approvals

query Parameters

itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request
history	boolean

Responses

Response samples

200
400
403

Content type

application/json

{"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0,
"approvals": [{"approvalUuid": "string",
"creatorUuid": "string",
"creatorUsername": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"expiryAt": "2019-08-24T14:15:22Z",
"closedAt": "2019-08-24T14:15:22Z",
"status": "PENDING",
"resource": "NONE",
"resourceAction": "string",
"objectUuid": "string",
"approvalProfileName": "string",
"approvalProfileUuid": "string"
}
]
}

Core API (2.16.3-SNAPSHOT)

Connector Management

Get details of a Connector

path Parameters

Responses

Response samples

Edit a Connector

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete a Connector

path Parameters

Responses

Response samples

Reconnect to a Connector

path Parameters

Responses

Response samples

Approve a Connector

path Parameters

Responses

Response samples

Reconnect multiple Connectors

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Connect to a Connector

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Approve multiple Connector

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List Connectors by Function Group and Kind

query Parameters

Responses

Response samples

Create a new Connector

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete multiple Connectors

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Validate Attributes

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Check Health of a Connector

path Parameters

Responses

Response samples

Get attributes of all Function Groups

path Parameters

Responses

Response samples

Get Attributes from a Connector

path Parameters

Responses

Response samples

Force Delete multiple Connectors

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

User Management

Get user details

path Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required